Clockwork

<strong>Solana automation engine</strong>







<a href="https://github.com/clockwork-xyz/clockwork/actions/workflows/code-scan.yaml"><img alt="code scan" src="https://github.com/clockwork-xyz/clockwork/actions/workflows/code-scan.yaml/badge.svg?branch=main" /></a>
<a href="https://discord.com/channels/889725689543143425"><img alt="Discord Chat" src="https://img.shields.io/discord/889725689543143425?color=blueviolet" /></a>
<a href="https://www.gnu.org/licenses/agpl-3.0.en.html"><img alt="License" src="https://img.shields.io/github/license/clockwork-xyz/clockwork?color=turquoise" /></a>

Home | Docs | Twitter

Deployments

SDKs

Notes

• Clockwork is under active development. All interfaces and implementations are subject to change.
• Official program deployments to Solana mainnet are secured by a 2-of-2 multisig and managed by the core team of software maintainers.
• To deploy a worker node on mainnet or devnet, please install the Clockwork geyser plugin on your Solana validator or RPC node and request an earlybird token delegation in the workernet channel on Discord.
• Occasionally, a new software release may change the state schema and require users to migrate to a new program. These releases will be marked by a new major version upgrade (e.g. v2.x, v3.x, etc.).
• The smart-contracts in this repository are automatically scanned by Sec3's auto-auditing software and are currently being reviewed by the team at Ottersec. Their audit report is in progress and will be published soon.

Getting Started

• "I am a developer, and I want to build a program on localnet"
• "I am a node operator, and I want to deploy a Clockwork worker"

Local Development

1. Install clockwork-cli.

If you are on linux, you might need to run this:

sudo apt-get update && sudo apt-get upgrade && sudo apt-get install -y pkg-config build-essential libudev-dev libssl-dev

Install with cargo:

cargo install -f --locked clockwork-cli

2. Run a localnet node.

clockwork localnet

3. Stream program logs.

solana logs --url localhost

Guides & Examples

• We have ready to run examples apps: https://github.com/clockwork-xyz/examples.
• If you are looking for walkthough, take a look at the docs: https://docs.clockwork.xyz/developers/guides.
• If you have a certain use case you would like to discuss, we are happy to help.

Deploying a worker

If you just want to test your smart contracts on localnet, check the previous section.

If you are a node operator looking to deploy the clockwork plugin, please talk to us for a smooth onboarding. Here's a one pager on how to be part of the automation network: https://docs.clockwork.xyz/workernet/deploying-a-worker.

Common Errors

Please refer to the FAQ.

Questions

Come build with us and ask questions on Discord!