https://github.com/keep-starknet-strange/shinigami

Bitcoin Script VM in Cairo
https://github.com/keep-starknet-strange/shinigami

bitcoin bitcoin-script cairo starknet

Last synced: about 1 year ago
JSON representation

Bitcoin Script VM in Cairo

Host: GitHub
URL: https://github.com/keep-starknet-strange/shinigami
Owner: keep-starknet-strange
License: mit
Created: 2024-07-24T04:49:32.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-10-20T01:12:49.000Z (over 1 year ago)
Last Synced: 2024-10-20T14:53:41.909Z (over 1 year ago)
Topics: bitcoin, bitcoin-script, cairo, starknet
Language: Cairo
Homepage: https://shinigamibtc.dev
Size: 3.52 MB
Stars: 58
Watchers: 11
Forks: 56
Open Issues: 14
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

***Bitcoin Script VM in Cairo***

## Overview

`shinigami` is a library for generic Bitcoin Script execution in Cairo, enabling the generation of STARK proofs for Bitcoin Script computation and Bitcoin transaction execution.

Key features :

- Bitcoin Script interpretation and execution
- Transaction execution and proving
- Frontend Script IDE with STARK prover integration
- Easily configurable VM ( enable different opcodes )
- In cairo, Bitcoin Script compiler

## Usage

### Running

#### Execute Mainnet Transaction

```bash
scarb build
./scripts/run_bitcoin_transaction.sh
```

#### Example ( 1st Bitcoin Transaction )

```bash
scarb build
./scripts/run_bitcoin_transaction.sh f4184fc596403b9d638783cf57adfe4c75c605f6356fbc91338530e9831e9e16
```

#### Execute custom script

```bash
./scripts/run_script.sh
```

#### Example ( Basic addition script )

```bash
./scripts/run_script.sh "OP_1 OP_2 OP_ADD OP_3 OP_EQUAL"
```

#### Other commands

Check out [this file](https://github.com/keep-starknet-strange/shinigami/blob/main/packages/cmds/src/main.cairo) to see other types of commands you can use with Shinigami!

### Building

```bash
scarb build
```

This will compile all the components.

### Testing

```bash
scarb test
```

This will run the test-suite for all opcodes, integration, and testing Scripts.

### Dependencies

The following are required to use / run shinigami :

- [scarb](https://docs.swmansion.com/scarb/)

## References

- [How To Contribute](./CONTRIBUTING.md)
- [Shinigami Supported Opcodes](./resources/supported-opcodes.md)
- [Shinigami Telegram](https://t.me/ShinigamiStarknet)
- [Shinigami OnlyDust](https://app.onlydust.com/p/shinigami)
- [Bitcoin Script Wiki](https://en.bitcoin.it/wiki/Script)

## Acknowledgements

Special thanks for these projects.

- [btcd](https://github.com/btcsuite/btcd/tree/master) : Bitcoin full node implementation written in Go, which heavily inspired the design of the Bitcoin Script engine in Shinigami. The amazing documentation and comments in btcd have been a gold mine and are appreciated.

## Contributors ✨

Also, thanks goes to these wonderful people. Follow the [contributors guide](https://github.com/keep-starknet-strange/shinigami/blob/main/CONTRIBUTING.md) if you'd like to take part.

_{Brandon R}
💻

_{A₿del ∞/21M 🐺 - 🐱}
💻

_okhai
💻

_{Supreme Labs}
💻

_{Kazeem Hakeem}
💻

_lomasson
💻

_{Prasanna Gautam}
💻

_{Olufemi Olumaiyegun}
💻

_Xavek
💻

_ptisserand
💻

_{Mubarak Muhammad Aminu}
💻

_Tristan
💻

_{Harsh Pratap Singh}
💻

_j1mbo64
💻

_{Jackson Xu}
💻

_{Esther Breath}
💻

_{Varun Doshi}
💻

_Zintarh
💻

_Oche
💻

_Mystic
💻

_Jemiiah
💻

_{Benedict Ejembi}
💻

_0xSpyC
💻

_{Armin Sabouri}
💻

_oluwapeski
💻

_ADR!AN
💻

_{Yusuf Habib}
💻

_{Oshioke Salaki}
💻

_{Emmanuel Soetan}
💻

_Mexes
💻

_Iwueseiter
💻

_{Shantel peters.}
💻

_{Nguyen Dao}
💻

_Hunter001
💻

_IsraelRex
🎨

_{Josue Sandino}
💻

_{martin machiebe}
💻

_Steven
💻

_Red
💻

_Charlotte
💻

_Na'omi-Gift
💻

_Zintarh
💻

_BlockyJ
💻

_{Sagar Rana}
💻

_Jean-Michel
💻

_{Cypher Pepe}
💻