本系列文档翻译版权归FireStack团队所有,转载请注明来源。
Scilla解释器提供了一个调用接口,让开发者可以通过特定输入信息来调用transition并获取输出结果。带有所支持的输入信息的合约执行后,将输出结果和智能合约的可变状态的改变。
调用接口
智能合约中定义的transition可以通过发布交易或另一个智能合约的消息来调用。上述两种方式都用同一个接口实现。
解释器(scilla-runner
)的输入包含四个输入JSON文件。每次调用执行transition的解释器都必须提供以下四个JSON:
./scilla-runner -init init.json -istate input_state.json -iblockchain input_blockchain.json -imessage input_message.json -o output.json -i input.scilla
可执行性解释器可以创建契约(用CreateContract
)或调用合约(用InvokeContract
)中的transition(即函数 )。参数的选用取决于用途。下表列出了这两种情况对应的参数。CreateContract
与InvokeContract
有很大不同,取决于用input_message.json
还是input_state.json
。如果不带上任何参数,那么解释器会优先选择 CreateContract
。否则,会视为InvokeContract
。请注意,对于CreateContract
,解释器仅执行基础检验,例如检查合约里的init.json
的不可变参数,以及合约定义是否有语法错误。
当下 | |||
---|---|---|---|
输入 | 描述 | CreateContract |
InvokeContract |
init.json |
不可改变的合同参数 | 是 | 是 |
input_state.json |
可变合同状态 | 没有 | 是 |
input_blockchain.json |
区块链状态 | 是 | 是 |
input_message.json |
转型和参数 | 没有 | 是 |
output.json |
产量 | 是 | 是 |
input.scilla |
输入合同 | 是 | 是 |
初始化不可变状态
init.json
定义了合约的不可变参数的值。它在调用时不会有任何变化。JSON是一个对象数组,每个对象包含以下字段:
字段 | 描述 |
---|---|
vname | 不可变合约参数的名称 |
type | 不可变合约参数的类型 |
value | 不可变合约参数的值 |
例1
下面给出的HelloWorld.scilla
合约,只有一个不可变的变量owner
。
contract HelloWorld
(* Immutable parameters *)
(owner: Address)
此合约的init.json
范例如下:
[
{
"vname" : "owner",
"type" : "Address",
"value" : "0x1234567890123456789012345678901234567890"
}
]
例2
下面给出的Crowdfunding.scilla
合约,有三个不可变的变量owner
,max_block
和goal
。
contract Crowdfunding
(* Immutable parameters *)
(owner : Address,
max_block : BNum,
goal : UInt128)
此合约的`init.json范例如下:
[
{
"vname" : "owner",
"type" : "Address",
"value" : "0x1234567890123456789012345678901234567890"
},
{
"vname" : "max_block",
"type" : "BNum" ,
"value" : "199"
},
{
"vname" : "goal",
"type" : "Uint128",
"value" : "500"
}
]
输入区块链状态
input_blockchain.json
将当前的区块链状态传给解释器。它类似于init.json
,但它是一个固定大小的对象数组,其中每个对象都有一个vname
字段,这个字段只来源于预设字段(对应于实际的区块链状态变量)。
允许的JSON字段:目前只允许value
不相同的JSON同时出现,如下例所示:
[
{
"vname" : "BLOCKNUMBER",
"type" : "BNum",
"value" : "3265"
}
]
输入消息
input_message.json
包含调用transition所需的信息。json是一个包含以下四个对象的数组:
字段 | 描述 |
---|---|
_tag | 要调用的transition |
_amount | 要转移的ZIL数量 |
_sender | 调用者的账户地址 |
params | 一组参数对象 |
这四个字段都是必需的。如果transition不带参数,则params
可以为空。
params
数组的编码方式与init.json
的类似,每个要被传递至所调用合约的参数都按照(vname
,type
,value
)的格式来指定。
例1
如下transition:
transition SayHello()
下面给出input_message.json
的例子:
{
"_tag" : "SayHello",
"_amount" : "0",
"_sender" : "0x1234567890123456789012345678901234567890",
"params" : []
}
例2
如下transition:
transition TransferFrom (from : Address, to : Address, tokens : Uint128)
下面给出input_message.json
的例子:
{
"_tag" : "TransferFrom",
"_amount" : "0",
"_sender" : "0x64345678901234567890123456789012345678cd",
"params" : [
{
"vname" : "from",
"type" : "Address",
"value" : "0x1234567890123456789012345678901234567890"
},
{
"vname" : "to",
"type" : "Address",
"value" : "0x78345678901234567890123456789012345678cd"
},
{
"vname" : "tokens",
"type" : "Uint128",
"value" : "500"
}
]
}
解释器输出
解释器将返回带有以下字段的JSON对象output.json
:
字段 | 描述 |
---|---|
message | 向另一个合约/非合约帐户发出的消息。 |
states | 新合约状态的对象数组 |
message
是一个JSON对象,它具有与 input_message.json
类似的格式。它有一个_recipient
字段,而_sender
字段没有这个字段。字段message
如下:
字段 | 描述 |
---|---|
_tag | 要调用的过渡 |
_amount | 要转移的ZIL数量 |
_recipient | 收件人的地址 |
_accepted | 合约是否已接受ZIL(真/假) |
params | 要传递的参数对象数组 |
params
数组的编码方式与init.json
的类似,每个要被传递至所调用合约的参数都按照(vname
,type
,value
)的格式来指定。
states
是一组对象,表示合约的可变状态。每个states
都按照(vname
,type
,value
)的格式来指定。
例1
以下示例是HelloWorld.scilla
的输出结果。
{
"message": {
"_tag" : "Main",
"_amount" : "0",
"_accepted" : "false",
"_recipient" : "0x1234567890123456789012345678901234567890",
"params" : [
{
"vname" : "code",
"type" : "Int32",
"value" : "2"
}
]
},
"states": [
{
"vname" : "_balance",
"type" : "Uint128",
"value" : "0"
},
{
"vname" : "welcome_msg",
"type" : "String",
"value" : "Hello World"
}
]
}
例2
这是另一个稍微复杂的例子,在states
里用到了Map
。
{
"message": {
"_tag" : "",
"_amount" : "0",
"_accepted" : "true",
"_recipient" : "0x12345678901234567890123456789012345678ab",
"params": [
{
"vname" : "code",
"type" : "Int32",
"value" : "1"
}
]
},
"states": [
{
"vname" : "_balance",
"type" : "Uint128",
"value" : "100"
},
{
"vname" : "backers",
"type" : "Map",
"value" : [
{
"keyType" : "Address",
"valType" : "Uint128"
},
{
"key" : "0x12345678901234567890123456789012345678ab",
"val" : "100"
}
]
},
{
"vname" : "funded",
"type" : "ADT",
"value" :
{
"constructor" : "False",
"argtypes" : [],
"arguments" : []
}
}
]
}
注意
对于作为可变的变量的
Map
类型,value
字段内容都是key
和value
形式。另外,请注意,ADT
类型的value
字段含3个子字段,即constructor
,argtypes
和arguments
。
输入可变合约状态
input_state.json
包含可变状态变量的当前值。它与output.json
里的states
字段具有相同的形式。以下是Crowdfunding.scilla
合约里的 input_state.json
。
[
{
"vname" : "backers",
"type" : "Map",
"value" : [
{
"keyType" : "Address",
"valType" : "Uint128"
},
{
"key" : "0x12345678901234567890123456789012345678ab",
"val" : "100"
}
]
},
{
"vname" : "funded",
"type" : "ADT",
"value" : {
"constructor" : "False",
"argtypes" : [],
"arguments" : []
}
},
{
"vname" : "_balance",
"type" : "Uint128",
"value" : "100"
}
]