cashscript-py 1.0.2

Python SDK for Bitcoin Cash (BCH) CashScript smart contracts.

CashScript-Py

CashScript-Py is a Python SDK for Bitcoin Cash (BCH) smart contract development. It is a port of the original TypeScript CashScript SDK. The goal is to enable Python developers (e.g., those working on server-side tools, bots, and Electron Cash plugins) to construct and interact with smart contracts on the BCH blockchain without re-implementing common low-level details.

CashScript-Py builds on earlier work by Jonald Fyookball on the anyhedge-ec-plugin.

Installation

Install from PyPI:

pip install cashscript-py

If you use uv:

uv add cashscript-py

Minimal example

from cashscript_py import Contract, ElectrumNetworkProvider, SignatureTemplate, TransactionBuilder

provider = ElectrumNetworkProvider("chipnet")
contract = Contract(artifact, constructor_args, provider)

unlocker = contract.unlock["spend"](SignatureTemplate(alice_wif))
builder = TransactionBuilder(provider).add_input(contract_utxo, unlocker).add_output(...)
tx_hex = builder.build()
print(tx_hex)

Documentation

• User guide: getting-started.md
• API documentation: https://cashscript-py.readthedocs.io/
• Runnable examples: examples/ (e.g. uv run python examples/op_return_memo.py, uv run python examples/hodl_vault.py)

Contributing

For local development setup, testing, documentation generation, and project workflow details, see:

• CONTRIBUTING.md
• STYLEGUIDE.md

Acknowledgements

• Original CashScript SDK: https://cashscript.org/
• AnyHedge Plugin: https://github.com/fyookball/anyhedge-ec-plugin
• Bitcash library: https://pybitcash.github.io/bitcash/