-
Notifications
You must be signed in to change notification settings - Fork 0
Tutorial 02 Language Basics
CellScript source reads best when you think of it as a small Cell story. First you name the module. Then you describe the state that can exist on chain. Finally you write the actions and locks that say how that state may change or be authorized.
- how a
.cellfile is organized; - when to use
struct,resource,shared, andreceipt; - what
actionentries do; - what
lockentries do; - which type shapes are part of the documented 0.12 production surface.
A source file normally contains:
- one
moduledeclaration; - persistent declarations such as
resource,shared, andreceipt; - optional ordinary
struct,enum, andconstdeclarations; - executable
actionandlockentries.
module spora::demo
Some older examples use a semicolon form:
module timelock_contract;
Prefer a stable module path for package code because module names are included in metadata and source identity.
Common field and parameter types include:
u8
u16
u32
u64
u128
bool
Address
Hash
[u8; 8]
Use fixed-size byte arrays when a value must be part of a persistent Molecule-compatible schema or a predictable CKB data layout.
Signature is not a built-in scalar. Model signatures as a struct or byte field when a contract needs to carry them:
struct Signature {
signer: Address
signature: [u8; 64]
}
For dynamic payloads that cross ABI or persistent schema boundaries, the documented 0.12 production surface includes targeted Vec<u8>, Vec<Address>, Vec<Hash>, and concrete fixed-width struct-vector paths. Generic collection ownership is intentionally narrower than "all collections are supported"; use the collections support matrix before advertising a collection shape as production-ready.
Use struct for ordinary typed data that is not itself a persistent Cell. A struct is a shape; it does not by itself create on-chain storage.
struct Config {
threshold: u64
}
Local struct values are transaction-local unless they are embedded in a persistent resource, shared, or receipt.
Use resource for linear Cell-backed assets. If your contract should not be able to duplicate or lose a value silently, it probably belongs in a resource.
resource Token has store, transfer, destroy {
amount: u64
symbol: [u8; 8]
}
Resources cannot be silently copied or dropped. The compiler tracks them as linear values.
Use shared for contention-sensitive state such as pools or registries. Shared state tells tools and schedulers that multiple transactions may care about the same Cell-backed value.
shared Pool has store {
token_reserve: u64
spora_reserve: u64
}
Shared state reads and writes remain visible in metadata so schedulers and policy checks can reason about transaction access.
Use receipt for single-use proof Cells. A receipt is useful when one action creates a right and another action later consumes that right.
receipt VestingGrant has store, claim {
beneficiary: Address
amount: u64
unlock_epoch: u64
}
Receipts are useful for deposits, vesting grants, voting records, settlement proofs, and claim flows.
Use action for type-script style transition logic. An action says what inputs are required, what checks must pass, and what new Cell state is produced.
action transfer_token(token: Token, to: Address) -> Token {
assert_invariant(token.amount > 0, "empty token")
consume token
create Token {
amount: token.amount,
symbol: token.symbol
} with_lock(to)
}
Use lock for authorization logic. Keep early locks boring: pass in the state and the signer-like value you need, then return a boolean.
shared Wallet has store {
owner: Address
nonce: u64
}
lock owner_only(wallet: &Wallet, signer: Address) -> bool {
wallet.owner == signer
}
Locks must return bool. Target-profile policy determines which runtime helpers are allowed. For example, Spora-only helper syscalls are rejected under the CKB profile, and CKB signature/witness verification must be represented through the supported claim/metadata/runtime evidence path instead of a generic verify_signature helper.
Use assertions for verifier conditions. They make the rule visible in source and in compiler metadata.
assert_invariant(amount > 0, "amount must be positive")
Assertions lower into script checks and appear in metadata as part of verifier analysis.
With the source shape in mind, continue with Resources and Cell Effects.