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

scarb build
./scripts/run_bitcoin_transaction.sh <tx-id>

Example ( 1st Bitcoin Transaction )

scarb build
./scripts/run_bitcoin_transaction.sh f4184fc596403b9d638783cf57adfe4c75c605f6356fbc91338530e9831e9e16

Execute custom script

./scripts/run_script.sh <quoted-script>

Example ( Basic addition script )

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

Other commands

Check out this file to see other types of commands you can use with Shinigami!

Building

scarb build

This will compile all the components.

Testing

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

References

• How To Contribute
• Shinigami Supported Opcodes
• Shinigami Telegram
• Shinigami OnlyDust
• Bitcoin Script Wiki

Acknowledgements

Special thanks for these projects.

• btcd : 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 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 💻