A JavaScript runtime environment for CKB-VM, built by adapting QuickJS. This project consists of two main components:
- ckb-js-vm: An on-chain script runtime engine that executes JavaScript code or bytecode
- ckb-js-std: TypeScript packages providing helper utilities for writing on-chain script
Ensure you have the following installed:
- pnpm, >= 10.4
- ckb-debugger, >= v0.200.1
- clang-18
pnpm create ckb-js-vm-app- The Little Book of ckb-js-vm - Step-by-step instructions for beginners
- Run
pnpm run docsto generate the latest API documentation locally (output will be available in thetypedocfolder) - Examples - Sample projects demonstrating key features
git submodule update --init
make allpnpm install
pnpm buildTo run the example project:
cd packages/examples
pnpm run start