README.md

ckb-js-vm

A JavaScript/TypeScript runtime environment for CKB-VM, built by adapting QuickJS. This project consists of two main components:

1. ckb-js-vm: An on-chain script runtime engine that executes JavaScript code or bytecode
2. ckb-js-std: TypeScript packages providing helper utilities for writing on-chain script

Prerequisites

Ensure you have the following installed:

• pnpm
• ckb-debugger
• clang-18

Quick Start with create-ckb-js-vm-app (Recommended)

pnpm create ckb-js-vm-app

Install Manually

Building ckb-js-vm (On-chain Script)

git submodule update --init
make all

Building ckb-js-std (TypeScript Packages)

pnpm install
pnpm build

Getting Started

To run the example project:

cd packages/examples
pnpm run start