Skip to content

Latest commit

 

History

History
120 lines (92 loc) · 4.88 KB

README.md

File metadata and controls

120 lines (92 loc) · 4.88 KB
Raw

Clockwork

Automation engine for the Solana blockchain

code scan Discord Chat License

Home | Docs | Twitter

Deployments

Program Address Devnet Mainnet
Network F8dKseqmBoAkHx3c58Lmb9TgJv5qeTf3BbtZZSEzYvUa v1.4.0 v1.4.0
Thread 3XXuUFfweXBwFgFfYaejLvZE4cGZiHgKiGfMtdxNzYmv v1.4.0 v1.4.0

Notes

  • Clockwork is under active development. All interfaces and implementations are subject to change.
  • The on-chain programs are upgradable by a 2-of-2 multisig controlled by a core team of maintainers.
  • Occassionally, an upgrade may require a migration to a new program. These releases will be marked with a new major version (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

Local Development

Download the source code:

git clone https://github.com/clockwork-xyz/clockwork
cd clockwork

The main branch is under active development and subject to bugs. To work with a stable version, checkout a release branch:

git describe --tags `git rev-list --tags --max-count=1`
git checkout tags/...

Build the repo:

./scripts/build-all.sh .
export PATH=$PWD/bin:$PATH

Start a local node for development:

clockwork localnet

To stream program logs:

solana logs --url localhost

Deploying a worker

To run the Clockwork plugin on your Solana validator, you can either build from scratch (shown above) or install the pre-built binary:

curl -s https://api.github.com/repos/clockwork-xyz/clockwork/releases/latest | grep "clockwork-geyser-plugin-release-x86_64-unknown-linux-gnu.tar" | cut -d : -f 2,3 | tr -d \" | wget -qi -
tar -xjvf clockwork-geyser-plugin-release-x86_64-unknown-linux-gnu.tar.bz2
rm clockwork-geyser-plugin-release-x86_64-unknown-linux-gnu.tar.bz2

Next, create a new keypair for signing Clockwork txs. Load this keypair with a small amount of SOL (~0.01 ◎). You will be compensated for lamports spent by the tasks your worker executes. Automation fees (rewards) are implemented and will soon be enabled.

solana-keygen new -o clockwork-worker-keypair.json

Then, setup the plugin config file in a folder where your validator startup script can reference it. Note, the libpath and keypath values should point to the binary and keypair mentioned in the steps above.

{
  "libpath": "/home/sol/clockwork-geyser-plugin-release/lib/libclockwork_plugin.so",
  "keypath": "/home/sol/clockwork-worker-keypair.json",
  "rpc_url": "http://127.0.0.1:8899",
  "transaction_timeout_threshold": 150,
  "thread_count": 10,
  "worker_id": 0,  // Set this to your worker ID!
}

Finally, add an additional line to your startup script to run your validator with the Clockwork plugin (often located at /home/sol/bin/validator.sh):

#!/bin/bash
exec solana-validator \
  --identity ~/validator-keypair.json \
  --rpc-port 8899 \
  --entrypoint entrypoint.devnet.solana.com:8001 \
  --no-voting \
  --full-rpc-api \
  --limit-ledger-size \
  
  # Add this line! 👇🏼
  --geyser-plugin-config ~/clockwork-geyser-config.json

Now simply restart your validator however you normally would!