上一篇我们讲述了如何简单安装Substrate区块链https://www.jianshu.com/p/8b1441094a73
这一篇，我们的目标是添加自定义的存储到Substrate 区块链中。
什么是Substrate Runtime?
Substrate是一个提供可定制区块链的平台，它使用Runtime作为区块所执行的逻辑。我们也可以把runtime看做是区块链状态转移函数 (State transition function STF)。
什么是Module？
在Substrate中，Runtime是由不同的功能组成的。这些功能可以丰富区块链，它们是：
- Account Management （账户管理）
- Token Balances （Token的结余）
- Governance （治理）
- Runtime Upgrades （Runtime升级）
- 其他
这些都是模块 (Modules)，完整的可以参考https://github.com/paritytech/substrate/tree/master/srml。这些默认的Substrate模块通常被称作SRML （Substrate Runtime Module Library）。
在Substrate框架下，我们可以很容易地添加并引入新的模块(Modules）到Runtime当中。
如何对Substrate的Runtime进行更新
在我们具体进入创建一个自定义的Substrate runtime，我们需要对一些知识进行了解，这样可以更好执行之后的代码。
Substrate runtime的代码会被编译成两个版本：
- WebAssembly (Wasm) image
- Binary executable （二进制可执行文件）
Wasm文件是被用作标准可执行文件编译的一部分，所以一定要先编译Wasm image，然后再进行二进制可执行文件的编译。
进入substrate-node-template文件夹（通过substrate-node-new 建立的，详情见上篇blog），具体编译的代码如下：
./scripts/build.sh // Build Wasm
cargo build --release // Build binary
当我们对node中的文件进行更改的时候，在节点上过去生成的区块仍旧会保留。但如果代码的改变过大，我们就需要将过去区块的数据清除，以便执行更改后的代码。清除数据的代码如下：
./target/release/substrate-node-template purge-chain --dev
注意：这里的substrate-node-template为用户自定义的节点名称，应随个人定义变化而变化，之后的代码同理。
接下来，我们就可以重启我们的节点：
./target/release/substrate-node-template --dev
创建一个Module (模块)
为了创建一个模块，我们需要在substrate-node-template/runtime/src文件夹下添加一个新的rust文件: verifiablecreds.rs，内容如下：
use support::{decl_storage, decl_module};
pub trait Trait: balances::Trait + timestamp::Trait {}
decl_storage! {
trait Store for Module<T: Trait> as VerifiableCreds {
// Declare storage and getter functions here
}
}
decl_module! {
pub struct Module<T: Trait> for enum Call where origin: T::Origin {
// Declare public functions here
}
}
这里提供了一个模板，它可以让我们写最基本的功能：公有函数 (public functions)和存储 (storage)。在我们添加具体功能之前，我们需要将这个文件作为模块添加到 lib.rs当中以便程序定位这个模块。
更新Runtime
进入lib.rs文件，我们可以看到它包含执行runtime所需要的所有模块 (modules)。对于每个模块，我们
- 将含有模块的Rust文件导入
- 实现对应的Trait
- 将模块添加到
construct_runtime!macro中。
首先我们将 mod verifiablecreds加入到lib.rs中：
// `lib.rs`
...
pub type BlockNumber = u64;
pub type Nonce = u64;
// Add this line
mod verifiablecreds;
...
然后，我们实现verifiablecreds对应的Trait：
// `lib.rs`
...
impl sudo::Trait for Runtime {
type Event = Event;
type Proposal = Call;
}
// Add this line
impl verifiablecreds::Trait for Runtime {}
...
最后，我们将 VerifiableCreds: verifiablecreds::{Module, Call, Storage},添加到construct_runtime!的定义中：
// `lib.rs`
...
construct_runtime!(
pub enum Runtime with Log(InternalLog: DigestItem<Hash, AuthorityId, AuthoritySignature>) where
Block = Block,
NodeBlock = opaque::Block,
UncheckedExtrinsic = UncheckedExtrinsic
{
System: system::{default, Log(ChangesTrieRoot)},
Timestamp: timestamp::{Module, Call, Storage, Config<T>, Inherent},
Consensus: consensus::{Module, Call, Storage, Config<T>, Log(AuthoritiesChange), Inherent},
Aura: aura::{Module},
Indices: indices,
Balances: balances,
Sudo: sudo,
TemplateModule: template::{Module, Call, Storage, Event<T>},
// Add this line
VerifiableCreds: verifiablecreds::{Module, Call, Storage},
}
);
...
注意，我们添加了三种类型到定义中：Module, Call, Storage。
接下来就是编译新加入的Module
./scripts/build.sh
cargo build --release
接下来的改动基本上都是基于verifiablecreds.rs来进行的。当然，我们可能会在lib.rs添加一些其他的代码。
在区块链中创建一个存储值
下面我们来添加一个最基本的逻辑到runtime中：一个函数可以存储一个值。
首先我们需要在decl_storage! macro里定义一个存储值。
use support::{decl_storage, decl_module, StorageValue};
pub trait Trait: system::Trait + timestamp::Trait {}
decl_storage! {
trait Store for Module<T: Trait> as VerifiableCreds {
SubjectCount: u32;
}
}
decl_module! {
pub struct Module<T: Trait> for enum Call where origin: T::Origin {
}
}
这里，我们定义了一个u32类型的值：SubjectCount。如果我们想要赋值给SubjectCount，可以：
<SubjectCount<T>>::put(x);
获取对应值也很类似：
<SubjectCount<T>>::get();
注意，以上两个方法均需要import对应的模块：support::StorageValue，否则会报错。
声明一个公有函数
公有函数是可以让区块链以外来调用的。下面我们来定义Runtime函数来设置或更改我们的存储值。这里我们需要更改decl_module! macro里的内容。
use support::{decl_storage, decl_module, StorageValue, dispatch::Result};
use system::ensure_signed;
pub trait Trait: system::Trait + timestamp::Trait {}
decl_storage! {
trait Store for Module<T: Trait> as VerifiableCreds {
SubjectCount: u32;
}
}
decl_module! {
pub struct Module<T: Trait> for enum Call where origin: T::Origin {
fn set_value(origin, value: u32) -> Result {
let sender = ensure_signed(origin)?;
<SubjectCount<T>>::put(value);
Ok(())
}
}
}
函数的结构
函数的基本结构为
fn foo(origin, bar: Bar, baz: Baz, ...) -> Result;
第一项为origin，之后为参数，返回值为Result。
Origin
第一个参数永远都是origin。origin包含这个函数调用者的信息。有三种可能性：
- 公有的调用：由外界账户签名
- 根调用（root call）：由governance治理系统调用
- Inherent调用：block authors（区块的提出者）和验证者调用。
Result
执行成功的函数会返回OK(())，否则程序会返回Err()。
检查消息签名
可以使用ensure_signed, ensure_root, ensure_inherent对origin的发起者进行验证。
存储Mapping（映射）
之前模块的功能只允许对所有用户存储一个单独的值。我们想实现对每个用户都存储他们自己的值。
因为我们需要使用用户的数据（AccountId，Moment）。所以我们需要使用：
pub trait Trait: system::Trait + timestamp::Trait {}
生命一个存储映射 (Storage Map)
映射是一个键值对：key, value。
decl_storage! {
trait Store for Module<T: Trait> as VerifiableCreds {
SubjectCount: u32;
Subjects: map u32 => T::AccountId;
}
}
注意，因为我们使用了map结构，需要import support::StorageMap类型。
如果我们想插入一个键值对，可以执行：
<SomeValue<T>>::insert(key, value);
获取对应key的值：
let my_value = <SomeValue<T>>::get(key);
当前完整的代码：
use support::{decl_storage, decl_module, StorageValue, StorageMap, dispatch::Result};
use system::ensure_signed;
pub trait Trait: system::Trait {}
decl_storage! {
trait Store for Module<T: Trait> as VerifiableCreds {
SubjectCount: u32;
Subjects: map u32 => T::AccountId;
}
}
decl_module! {
pub struct Module<T: Trait> for enum Call where origin: T::Origin {
fn create_subject(origin) -> Result {
let sender = ensure_signed(origin)?;
let subject = <SubjectCount<T>>::get();
<SubjectCount<T>>::put(subject + 1);
<Subjects<T>>::insert(subject, sender);
Ok(())
}
}
}
接下来就可以编译新生成的Module：
./scripts/build.sh
cargo build --release
./target/release/substrate-node-template purge-chain --dev
然后启动我们的节点：
./target/release/substrate-node-template --dev
这样，模块就被加到区块链上了。
关于如何用新模块和区块链进行交互，我们会在下一个blog中介绍。
未完待续。。。
网友评论