CashScript-Py documentation

Python SDK documentation for building and interacting with Bitcoin Cash smart contracts.

Guides

• Getting started (Chipnet)
  • Install
  • 1) Prepare Chipnet funds (FAUCET_WIF)
  • 2) Run the example (choose Transfer or Timeout)
• Python SDK
  • When to use the SDK
  • The 4 SDK classes
  • SDK usage
  • Advanced: non-CashScript contracts
• Contract Instantiation
  • Creating a Contract
  • Contract Properties
  • Contract Methods
• Transaction Builder
  • Instantiating a transaction builder
  • Transaction building
  • Completing the transaction
  • Transaction errors
• Network Provider
  • Interface NetworkProvider
  • Custom NetworkProviders
  • Provider-specific functionality
  • Limitations
• Electrum Network Provider
  • Creating an ElectrumNetworkProvider
  • ElectrumNetworkProvider methods
• Other Network Providers
  • MockNetworkProvider
  • Other providers
• Signature Templates
  • SignatureTemplate
  • SignatureTemplate methods
  • Advanced usage
  • Notes on contract sig arguments
• Testing Setup
  • chipnet prerequisites (FAUCET_WIF)
  • Install dev dependencies
  • Environment variables
  • Automated testing (pytest)
  • Notes for “mocknet-style” tests
• Examples
  • HodlVault

API Reference

• cashscript_py package
  • Contract
  • ElectrumNetworkProvider
  • HashType
  • LockingBytecodeType
  • Network
  • NetworkProvider
  • NftCapability
  • Output
  • SignatureAlgorithm
  • SignatureTemplate
  • TokenDetails
  • TransactionBuilder
  • Utxo
  • Subpackages
  • Submodules