Deployment plans

Deployment plans are reproducible deployment steps that publish a collection of on-chain transactions and one or more contracts to a network.

The default deployment plan of every Clarinet project is contained within specifications set inside certain files. In addition to this default deployment plan, the user can manually configure each plan, adding additional transactions or contract calls across multiple Stacks or Bitcoin blocks.

You can commit, audit, and test contracts without including any secrets in the deployment plan, and you can share these contracts without exposing any sensitive information.

Deployment plan primitives

Transaction primitiveTypical usage
Publish contractsDeploy a contract to an in-memory simulated Stacks chain.
Deploy to a public testnet or mainnet.
Deploy an external contract to your local network for testing.
Call contract functionsCall a contract deployed to any of your local devnets or public networks.
Send BTCPerform a simple bitcoin transfer from a p2pkh address to a p2pkh address.
Wait for blockTest or automate contract deployment across multiple Stacks or Bitcoin blocks.
Send STXSend stacks to an address or contract.