-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
128 additions
and
92 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| name: build | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| push: | ||
| branches: | ||
| - main | ||
| pull_request: | ||
| permissions: read-all | ||
|
|
||
| jobs: | ||
| check: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - uses: asdf-vm/actions/install@v3 | ||
|
|
||
| - run: scarb fmt --check | ||
|
|
||
| - name: build with scarb | ||
| run: scarb build | ||
|
|
||
| - name: build bindings with cargo | ||
| run: cd bindings ; cargo build | ||
|
|
||
| - name: test bindings | ||
| run: snforge test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,92 +1,100 @@ | ||
| <div align="center"> | ||
| <img src="book/src/assets/blobstreamSnBanner.png" alt="blobstream_sn" height="300"/> | ||
|
|
||
| ***Where Modularism meets Integrity*** | ||
|
|
||
| [](https://github.com/keep-starknet-strange/blobstream-starknet/actions/workflows/check.yml) | ||
| [](https://github.com/keep-starknet-strange/blobstream-starknet/actions/workflows/build.yml) | ||
|
|
||
| [](https://github.com/keep-starknet-strange) | ||
|
|
||
| </div> | ||
|
|
||
| ## Overview | ||
|
|
||
| `blobstream_sn` is a port of Celestia Blobstream X [contracts](https://github.com/succinctlabs/blobstreamx) | ||
| in [Cairo](https://book.cairo-lang.org/) for [Starknet](https://starknet.io/). | ||
|
|
||
| See the book to dive down the [blobhole...](https://blobstream-stark.net) | ||
|
|
||
| ## Build | ||
|
|
||
| To build the project, run: | ||
|
|
||
| ```bash | ||
| scarb build | ||
| ``` | ||
|
|
||
| ## Test | ||
|
|
||
| To test the project, run: | ||
|
|
||
| ```bash | ||
| snforge test | ||
| ``` | ||
|
|
||
| ## Bindings (Rust) | ||
|
|
||
| To build/update the bindings, first build the contract with `scarb`. | ||
|
|
||
| Then, within the Rust project `bindings/` run: | ||
|
|
||
| ````bash | ||
| cargo build | ||
| ```` | ||
|
|
||
| ## Scripts | ||
|
|
||
| ### `submit-state-diff` | ||
|
|
||
| You must have a Celestia light node for this script. | ||
| Follow this [tutorial](https://docs.celestia.org/developers/node-tutorial) to init | ||
| a node for the [Mocha testnet](https://docs.celestia.org/nodes/mocha-testnet). | ||
|
|
||
| ```bash | ||
| bash scripts/submit-state-diff.sh | ||
| ``` | ||
|
|
||
| ## Contributors ✨ | ||
|
|
||
| We live on contributions. If you'd like to contribute please follow the [guide](CONTRIBUTING.md). | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-disable --> | ||
| <table> | ||
| <tbody> | ||
| <tr> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/AbdelStark"><img src="https://avatars.githubusercontent.com/u/45264458?v=4?s=100" width="100px;" alt="Abdel @ StarkWare "/><br /><sub><b>Abdel @ StarkWare </b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=AbdelStark" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/drspacemn"><img src="https://avatars.githubusercontent.com/u/16685321?v=4?s=100" width="100px;" alt="drspacemn"/><br /><sub><b>drspacemn</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=drspacemn" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/JordyRo1"><img src="https://avatars.githubusercontent.com/u/87231934?v=4?s=100" width="100px;" alt="Jordy Romuald"/><br /><sub><b>Jordy Romuald</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=JordyRo1" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/ermvrs"><img src="https://avatars.githubusercontent.com/u/3417324?v=4?s=100" width="100px;" alt="Erim"/><br /><sub><b>Erim</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=ermvrs" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/othman-sefraoui/"><img src="https://avatars.githubusercontent.com/u/50746496?v=4?s=100" width="100px;" alt="OthmanSefraoui"/><br /><sub><b>OthmanSefraoui</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=OthmanSefraoui" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/b-j-roberts"><img src="https://avatars.githubusercontent.com/u/54774639?v=4?s=100" width="100px;" alt="Brandon R"/><br /><sub><b>Brandon R</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=b-j-roberts" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/Akashneelesh"><img src="https://avatars.githubusercontent.com/u/66639153?v=4?s=100" width="100px;" alt="Akashneelesh"/><br /><sub><b>Akashneelesh</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=Akashneelesh" title="Code">💻</a></td> | ||
| </tr> | ||
| <tr> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/FlorianLgrs"><img src="https://avatars.githubusercontent.com/u/96090364?v=4?s=100" width="100px;" alt="FlorianLgrs"/><br /><sub><b>FlorianLgrs</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=FlorianLgrs" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/ametel01"><img src="https://avatars.githubusercontent.com/u/91626827?v=4?s=100" width="100px;" alt="Alex Metelli"/><br /><sub><b>Alex Metelli</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=ametel01" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/faytey"><img src="https://avatars.githubusercontent.com/u/40033608?v=4?s=100" width="100px;" alt="faytey"/><br /><sub><b>faytey</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=faytey" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/remybar"><img src="https://avatars.githubusercontent.com/u/57539816?v=4?s=100" width="100px;" alt="Rémy Baranx"/><br /><sub><b>Rémy Baranx</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=remybar" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/0xicosahedron"><img src="https://avatars.githubusercontent.com/u/83328087?v=4?s=100" width="100px;" alt="Icosahedron"/><br /><sub><b>Icosahedron</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=0xicosahedron" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/thomas192"><img src="https://avatars.githubusercontent.com/u/65908739?v=4?s=100" width="100px;" alt="0xK2"/><br /><sub><b>0xK2</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=thomas192" title="Code">💻</a></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:END --> | ||
|
|
||
| This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! | ||
| <div align="center"> | ||
| <img src="book/src/assets/blobstreamSnBanner.png" alt="blobstream_sn" height="300"/> | ||
|
|
||
| ***Where Modularism meets Integrity*** | ||
|
|
||
| [](https://github.com/keep-starknet-strange/blobstream-starknet/actions/workflows/check.yml) | ||
| [](https://github.com/keep-starknet-strange/blobstream-starknet/actions/workflows/build.yml) | ||
|
|
||
| [](https://github.com/keep-starknet-strange) | ||
|
|
||
| </div> | ||
|
|
||
| ## Overview | ||
|
|
||
| `blobstream_sn` is a port of Celestia Blobstream X [contracts](https://github.com/succinctlabs/blobstreamx) | ||
| in [Cairo](https://book.cairo-lang.org/) for [Starknet](https://starknet.io/). | ||
|
|
||
| See the book to dive down the [blobhole...](https://blobstream-stark.net) | ||
|
|
||
| ## Install tools and dependencies | ||
|
|
||
| The project relies on scarb. You have to install it first then. | ||
|
|
||
| ``` | ||
| curl --proto '=https' --tlsv1.2 -sSf https://docs.swmansion.com/scarb/install.sh | sh -s -- -v nightly | ||
| ``` | ||
|
|
||
| ## Build | ||
|
|
||
| To build the project, run: | ||
|
|
||
| ```bash | ||
| scarb build | ||
| ``` | ||
|
|
||
| ## Test | ||
|
|
||
| To test the project, run: | ||
|
|
||
| ```bash | ||
| snforge test | ||
| ``` | ||
|
|
||
| ## Bindings (Rust) | ||
|
|
||
| To build/update the bindings, first build the contract with `scarb`. | ||
|
|
||
| Then, within the Rust project `bindings/` run: | ||
|
|
||
| ````bash | ||
| cargo build | ||
| ```` | ||
|
|
||
| ## Scripts | ||
|
|
||
| ### `submit-state-diff` | ||
|
|
||
| You must have a Celestia light node for this script. | ||
| Follow this [tutorial](https://docs.celestia.org/developers/node-tutorial) to init | ||
| a node for the [Mocha testnet](https://docs.celestia.org/nodes/mocha-testnet). | ||
|
|
||
| ```bash | ||
| bash scripts/submit-state-diff.sh | ||
| ``` | ||
|
|
||
| ## Contributors ✨ | ||
|
|
||
| We live on contributions. If you'd like to contribute please follow the [guide](CONTRIBUTING.md). | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-disable --> | ||
| <table> | ||
| <tbody> | ||
| <tr> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/AbdelStark"><img src="https://avatars.githubusercontent.com/u/45264458?v=4?s=100" width="100px;" alt="Abdel @ StarkWare "/><br /><sub><b>Abdel @ StarkWare </b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=AbdelStark" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/drspacemn"><img src="https://avatars.githubusercontent.com/u/16685321?v=4?s=100" width="100px;" alt="drspacemn"/><br /><sub><b>drspacemn</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=drspacemn" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/JordyRo1"><img src="https://avatars.githubusercontent.com/u/87231934?v=4?s=100" width="100px;" alt="Jordy Romuald"/><br /><sub><b>Jordy Romuald</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=JordyRo1" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/ermvrs"><img src="https://avatars.githubusercontent.com/u/3417324?v=4?s=100" width="100px;" alt="Erim"/><br /><sub><b>Erim</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=ermvrs" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/othman-sefraoui/"><img src="https://avatars.githubusercontent.com/u/50746496?v=4?s=100" width="100px;" alt="OthmanSefraoui"/><br /><sub><b>OthmanSefraoui</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=OthmanSefraoui" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/b-j-roberts"><img src="https://avatars.githubusercontent.com/u/54774639?v=4?s=100" width="100px;" alt="Brandon R"/><br /><sub><b>Brandon R</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=b-j-roberts" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/Akashneelesh"><img src="https://avatars.githubusercontent.com/u/66639153?v=4?s=100" width="100px;" alt="Akashneelesh"/><br /><sub><b>Akashneelesh</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=Akashneelesh" title="Code">💻</a></td> | ||
| </tr> | ||
| <tr> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/FlorianLgrs"><img src="https://avatars.githubusercontent.com/u/96090364?v=4?s=100" width="100px;" alt="FlorianLgrs"/><br /><sub><b>FlorianLgrs</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=FlorianLgrs" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/ametel01"><img src="https://avatars.githubusercontent.com/u/91626827?v=4?s=100" width="100px;" alt="Alex Metelli"/><br /><sub><b>Alex Metelli</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=ametel01" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/faytey"><img src="https://avatars.githubusercontent.com/u/40033608?v=4?s=100" width="100px;" alt="faytey"/><br /><sub><b>faytey</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=faytey" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/remybar"><img src="https://avatars.githubusercontent.com/u/57539816?v=4?s=100" width="100px;" alt="Rémy Baranx"/><br /><sub><b>Rémy Baranx</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=remybar" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/0xicosahedron"><img src="https://avatars.githubusercontent.com/u/83328087?v=4?s=100" width="100px;" alt="Icosahedron"/><br /><sub><b>Icosahedron</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=0xicosahedron" title="Code">💻</a></td> | ||
| <td align="center" valign="top" width="14.28%"><a href="https://github.com/thomas192"><img src="https://avatars.githubusercontent.com/u/65908739?v=4?s=100" width="100px;" alt="0xK2"/><br /><sub><b>0xK2</b></sub></a><br /><a href="https://github.com/keep-starknet-strange/blobstream-starknet/commits?author=thomas192" title="Code">💻</a></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:END --> | ||
|
|
||
| This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! |