语言语法规范
本文档描述 .ct 合约语言面向用户的语法规则。
完整语法规范(BNF表示法)
// 程序结构
program ::= [import_statement]* [library]* contract
import_statement ::= "import" import_target NEWLINE
import_target ::= dotted_name | STRING
dotted_name ::= IDENTIFIER ["." IDENTIFIER]*
// 库定义
library ::= "Library" dotted_name ":" NEWLINE INDENT [lib_member]+ DEDENT
lib_member ::= function | struct
// 合约定义
contract ::= "Contract" IDENTIFIER ":" NEWLINE INDENT [member]* DEDENT
member ::= function | struct
// 函数定义
function ::= "def" IDENTIFIER "(" [parameter_list] ")" ["->" return_type] ":" block
parameter_list ::= parameter ["," parameter]*
parameter ::= IDENTIFIER ":" TYPE
// 结构体定义
struct ::= "Struct" IDENTIFIER ":" NEWLINE INDENT [field]+ DEDENT
field ::= IDENTIFIER ":" type_expression NEWLINE
type_expression ::= TYPE
| TYPE "[" NUMBER "]" // 定长数组
| inline_struct_type // 内联匿名结构
inline_struct_type ::= "{" field_decl ("," field_decl)* "}"
field_decl ::= IDENTIFIER ":" TYPE
// 语句
statement ::= if_statement
| for_statement
| return_statement
| assignment_statement
| destructure_assignment
| variable_declaration
| expression_statement
block ::= NEWLINE INDENT [statement]* DEDENT
if_statement ::= "if" expression ":" block ["else" ":" block]
for_statement ::= "for" IDENTIFIER "in" "Range" "(" expression "," expression "," expression ")" ":" block
return_statement ::= "Return" expression NEWLINE
| "return" expression NEWLINE
assignment_statement ::= (IDENTIFIER | field_access) "=" expression NEWLINE
destructure_assignment ::= "{" identifier_list "}" "=" expression NEWLINE
identifier_list ::= IDENTIFIER ["," IDENTIFIER]*
variable_declaration ::= IDENTIFIER ":" type_expression ["=" expression] NEWLINE
expression_statement ::= expression NEWLINE
// 表达式
expression ::= binary_expression
| unary_expression
| primary_expression
binary_expression ::= expression binary_operator expression
unary_expression ::= unary_operator expression
primary_expression ::= IDENTIFIER
| literal
| function_call
| method_call
| field_access
| Clone_expression
| brace_expression
| "(" expression ")"
brace_expression ::= "{" [expression_list] "}"
expression_list ::= expression ["," expression]*
function_call ::= IDENTIFIER "(" [argument_list] ")"
method_call ::= expression "." IDENTIFIER "(" [argument_list] ")"
field_access ::= expression "." IDENTIFIER
clone_expression ::= IDENTIFIER "." "Clone" "(" ")"
argument_list ::= expression ["," expression]*
// 字面量
literal ::= NUMBER | HEX | STRING | ADDRESS | BOOL
// 操作符
binary_operator ::= "+" | "-" | "*" | "/"
| "==" | "!=" | "<" | ">" | "<=" | ">="
unary_operator ::= "-" | "+"
// 词法元素
IDENTIFIER ::= [a-zA-Z_][a-zA-Z0-9_]*
NUMBER ::= [0-9]+
HEX ::= "0x"[0-9a-fA-F]+
STRING ::= '"' [^"]* '"'
ADDRESS ::= '"' '1' [1-9A-HJ-NP-Za-km-z]{33} '"' // Base58 P2PKH 地址
TYPE ::= IDENTIFIER ("[" NUMBER "]")? // 含定长数组形式 hex32 / uint64[6] 等
NEWLINE ::= '\n'
INDENT ::= 增加缩进级别
DEDENT ::= 减少缩进级别1. 程序结构
1.1 程序定义
program ::= [import_statement]* [library]* contract合约文件可在开头写 import。被导入的库会在合约编译前可用,因此一个解析完成后的完整程序由零个或多个库块,加上一个合约块组成。
import std.p2pkh
import "./local_utils.ct"
Contract Wallet:
def main(signature: hex, pubKey: hex):
ok = verifyP2PKH(signature, pubKey, self.pubKeyHash)import std.p2pkh 会解析到标准库根目录下的 std/p2pkh.ct;import "./local_utils.ct" 会按当前文件所在目录解析相对路径。循环导入会被拒绝,重复导入同一个库时只展开一次。
1.2 合约定义
contract ::= "Contract" IDENTIFIER ":" NEWLINE INDENT [member]* DEDENT
member ::= function | struct合约以关键字 Contract 开始,后跟合约名称,使用 Python 风格的缩进结构。
1.3 库定义
library ::= "Library" dotted_name ":" NEWLINE INDENT [lib_member]+ DEDENT
lib_member ::= function | struct库用于复用结构体和辅助函数,名称支持 dotted path,例如 Library std.p2pkh:。库块内禁止定义 main。导入后的库函数会在编译期对宿主合约可用,按私有辅助函数处理;即使函数名不以下划线开头,也不会作为 ABI 的公有函数暴露。
实例数据建议显式作为参数传入库函数。例如 std.p2pkh 接收 pubKeyHash 参数,宿主合约在调用处传入 self.pubKeyHash。这样库的接口会直接体现在函数签名中。
2. 数据结构
2.1 结构体定义
struct ::= "Struct" IDENTIFIER ":" NEWLINE INDENT [field]+ DEDENT
field ::= IDENTIFIER ":" TYPE NEWLINE结构体定义必须包含至少一个字段,每个字段都必须有类型声明。
示例:
Struct Person:
name: string
age: int
publicKey: hex
walletAddress: address3. 函数定义
3.1 普通函数
function ::= "def" IDENTIFIER "(" [parameter_list] ")" ["->" TYPE] ":" block
parameter_list ::= parameter ["," parameter]*
parameter ::= IDENTIFIER ":" TYPE函数参数必须包含类型声明。
示例:
def _checkSig(sig: hex, pubKey: hex):
return CheckSig(sig, pubKey)3.2 公有函数与私有函数
- 公有函数:函数名不以
_开头,是合约的"花费入口"。一个合约可以包含多个公有函数;它们按声明顺序串行执行,调用方需要为所有公有函数提供解锁参数。 - 私有函数:函数名以
_开头,仅供合约内部调用,可使用return把值返回给调用方。 - 库函数:来自
Library的函数按私有函数处理,不进入 ABI。
def verify(sig: hex, pubKey: hex): # 公有
_checkOwner(sig, pubKey)
Return (1 == 1)
def _checkOwner(sig: hex, pubKey: hex): # 私有
EqualVerify(Hash160(pubKey.Clone()), self.pubKeyHash)
CheckSigVerify(sig, pubKey)4. 语句
4.1 语句类型
statement ::= if_statement
| for_statement
| return_statement
| assignment_statement
| destructure_assignment
| variable_declaration
| expression_statement
block ::= NEWLINE INDENT [statement]* DEDENT4.2 条件语句
if_statement ::= "if" expression ":" block ["else" ":" block]示例:
if amount > threshold:
CheckSigVerify(sig, pubKey)
else:
Return (1 == 0)4.3 循环语句
for_statement ::= "for" IDENTIFIER "in" "Range" "(" expression "," expression "," expression ")" ":" blockRange(start, stop, step) 的语义类似 Python 的 range,但循环边界必须在编译期可确定。stop 是开区间。step 可正可负,常用 Range(N-1, -1, -1) 实现倒序遍历。
示例:
# 倒序遍历输出 0..2
for i in Range(2, -1, -1):
Delete(pretx.Outputs[i].Value)4.5 返回语句
return_statement ::= "Return" expression NEWLINE
| "return" expression NEWLINEReturn(大写)用于公有函数,将表达式结果作为合约最终返回值;return(小写)用于私有函数把值返回给调用方。
4.6 赋值语句
assignment_statement ::= (IDENTIFIER | field_access) "=" expression NEWLINE
field_access ::= expression "." IDENTIFIER示例:
x = 10
self.value = result
Sub.x = 04.7 解构赋值
destructure_assignment ::= "{" identifier_list "}" "=" expression NEWLINE用于承接返回多个值的函数(如 Split),或按字段顺序初始化结构体字面量。
示例:
{header, body} = Split(rawData, 4) # 多返回值
point: Point = {10, 20} # 结构体字面量4.8 变量声明
variable_declaration ::= IDENTIFIER ":" type_expression ["=" expression] NEWLINE示例:
count: int
name: string = "default"
btcAddress: address = "1RainRzqJtJxHTngafpCejDLfYq2y4KBc"
amount: uint64[6] = temp_data.Slice(3, 48)5. 表达式
5.1 表达式类型
expression ::= binary_expression
| unary_expression
| primary_expression
primary_expression ::= IDENTIFIER
| literal
| function_call
| method_call
| field_access
| "(" expression ")"
literal ::= NUMBER | HEX | STRING | ADDRESS字面量类型说明:
NUMBER: 整数字面量,如42,-10HEX: 十六进制字面量,如0xabcd,0x1234STRING: 字符串字面量,如"hello","世界"BOOL: 布尔字面量,如1,0ADDRESS: 比特币地址字面量,仅支持以1开头的Base58地址(P2PKH),34字符,如"1RainRzqJtJxHTngafpCejDLfYq2y4KBc"
示例:
# 地址字面量示例
p2pkhAddr: address = "1RainRzqJtJxHTngafpCejDLfYq2y4KBc" # P2PKH地址5.2 函数调用
function_call ::= IDENTIFIER "(" [argument_list] ")"
argument_list ::= expression ["," expression]*示例:
CheckSig(pubkey, sig)
Sha256(data)
EqualVerify(hash1, hash2)5.3 方法调用和字段访问
method_call ::= expression "." IDENTIFIER "(" [argument_list] ")"
field_access ::= expression "." IDENTIFIER支持链式调用:
obj.field1.field2
obj.field.method()5.4 二元运算
binary_expression ::= expression binary_operator expression
binary_operator ::= "+" | "-" | "*" | "/"
| "==" | "!=" | "<" | ">" | "<=" | ">="5.5 一元运算
unary_expression ::= unary_operator expression
unary_operator ::= "-" | "+"6. 词法元素
6.1 关键字
keywords ::= "Contract" | "Struct" | "def" | "if" | "else" | "for" | "in" | "Return" | "return"注意:
Range不是关键字,而是只能出现在for ... in Range(...)头部的内置函数;Clone/Push/SetAlt/SetMain/Delete/Keep等同样是普通内置函数(详见 内置函数参考)。
6.2 标识符和字面量
IDENTIFIER ::= [_a-zA-Z][_a-zA-Z0-9]*
NUMBER ::= [0-9]+
HEX ::= "0x"[0-9a-fA-F]+
STRING ::= '"' [^"]* '"'
ADDRESS ::= '"' '1' [1-9A-HJ-NP-Za-km-z]{33} '"' // Base58 P2PKH 地址(首字符固定为 1)
BOOL ::= "1" | "0" // 与 NUMBER 共享词法形式,由上下文决定语义
TYPE ::= IDENTIFIER ("[" NUMBER "]")? // 含定长数组形式 hex32 / uint64[6] 等6.3 操作符和分隔符
operators ::= "=" | "==" | "!=" | "<" | ">" | "<=" | ">="
| "+" | "-" | "*" | "/" | "->"
delimiters ::= "(" | ")" | "[" | "]" | ":" | "," | "."6.4 缩进和换行
语言使用Python风格的缩进来表示代码块结构:
NEWLINE: 换行符INDENT: 增加缩进级别DEDENT: 减少缩进级别
7. 所有权系统
该语言实现了类似Rust的所有权概念,但仅对数据变量有约束:
7.1 所有权规则
- 变量消耗: 当局部变量被使用(作为函数参数、赋值给其他变量等)时,原变量的所有权被转移
- 合约成员变量例外: 合约的成员变量(如
self.field)在编译时会被直接替换到代码中,因此不受所有权约束,可以多次使用而无需 Clone - 克隆操作: 对于局部变量,使用
Clone()函数可以创建变量的副本,避免所有权转移 - 字段访问: 访问结构体实例的字段会消耗该字段的所有权,如需多次访问需要先克隆;但合约成员变量不受此限制
- 特殊内置函数:
SetAlt()和SetMain()函数不会消耗变量的所有权
7.2 克隆语法
clone_expression ::= IDENTIFIER "." "Clone" "(" ")"示例:
original_value = 42
cloned_value = original_value.Clone()
# original_value 仍然可用7.3 内置函数
语言提供以下内置函数:
Clone(): 创建变量的副本,语法为variable.Clone()SetAlt(variable): 将变量移动到副栈,不消耗变量所有权SetMain(variable): 将变量从副栈移动到主栈,不消耗变量所有权- 其他内置函数: 如
CheckSig(),Sha256()等,遵循普通函数调用语法并消耗参数的所有权
7.4 所有权系统示例
局部变量的所有权转移:
data = Push("0x1234")
result1 = CheckSig(data, signature) # data 被消耗,不能再次使用
# result2 = CheckSig(data, signature2) # 错误:data 已被消耗
# 需要克隆才能多次使用
data2 = Push("0x5678")
cloned_data = data2.Clone()
result1 = CheckSig(data2, signature1)
result2 = CheckSig(cloned_data, signature2) # 正确:使用克隆的副本合约成员变量的特殊行为:
def main(sig1: string, sig2: string):
# 合约成员变量可以多次使用,无需 Clone
result1 = CheckSig(self.pubKey, sig1)
result2 = CheckSig(self.pubKey, sig2) # 正确:self.pubKey 可以重复使用
return {result1, result2}特殊内置函数:
data: hex = "0x1234"
SetAlt(data) # data 仍然可用,所有权未被消耗
SetMain(data) # data 仍然可用,所有权未被消耗8. 大括号语法糖 ({} 语法)
8.1 语法定义
brace_expression ::= "{" [expression_list] "}"
destructure_assignment ::= "{" identifier_list "}" "=" expression NEWLINE8.2 用途和语义
大括号语法糖 {} 是一个多功能的语法特性,根据上下文有不同的语义:
8.2.1 多返回值解构
用于承接函数的多个返回值:
{a, b} = Split(data, 10) # Split 返回两个值,分别赋给 a 和 b
{x, y, z} = _GetCoordinates() # 承接三个返回值8.2.2 结构体字面量
用于创建结构体实例:
Struct Point:
x: int
y: int
# 使用大括号语法糖创建结构体实例
p: Point = {10, 20}快速回顾
- 一个源文件可以包含导入、库定义和一个合约定义。
Struct用来描述固定字段顺序的数据结构,常用于交易片段。- 公有函数和私有函数的区别由函数名决定:以下划线开头的是私有辅助函数。
Range()只能用于编译期确定次数的循环。- 大括号
{}主要用于多返回值解构和结构体字面量。
下一步
- 调试器用户使用手册 — 详细的调试器功能说明