(http://coral.qq.com/3888157639)
Parity的Substrate区块链框架,在最终版本开发中取得不错的进展。Ink是Parity为基于Substrate的区块链编写智能合约的解决方案。
与Substrate一样,Ink建立在Rust之上,因此遵循Rust语言规则和语法。本文将介绍一个示例在智能合约中复制一个ERC721令牌,通常称为以太坊区块链上的ERC721令牌。
这是系列文章的第1部分,将介绍创建和部署此Ink智能合约的过程,具体来说,我们将介绍:
如何安装Substrate 和Ink及其依赖项;
编写支持3个主要功能的简单不可替代令牌合同:创造令牌,转移令牌,以及批准另一个帐户代表发送令牌;
如何在Substrate区块链上构建和部署智能合约,并使用Polkadot JS应用程序在链上测试功能;
注意:Polkadot JS应用程序不仅设计用于管理Polkadot本身,还管理任何Substrate链。接口是动态的,因为可用的管理选项取决于Substrate链支持的功能。
在本文中,我们将介绍Ink的安装过程及其所需的依赖关系,并介绍本系列附带的ERC721令牌示例合同,讨论Ink合同的结构以及它与基于Solidity的合同的区别,以及两者之间的相似性。
非同质化令牌
非同质化令牌NFT与ERC20型令牌不同,每个令牌都是独一无二的。在我们的合同中,每个令牌都有一个用于表示令牌的唯一ID。从这里开始,每个令牌都可以拥有自己的值,自己的元数据,或者在应用程序或价值系统中具有特定用途。
批准转移或管理令牌的非所有者帐户也是不同的,并且必须在每个令牌的基础上使用NFT完成。 加密猫是最着名的例子,其中实现了非同质化令牌- 每个令牌代表平台上的小猫。
NFT对标准令牌提出了不同的挑战,因此我们可以根据Ink语法和功能进行更多探讨。让我们下一步安装Substrate,Ink和所需的软件包来编写我们的智能合约。
系统安装
开始编写Ink合约需要一些依赖包。安装后,我们可以在终端窗口-中运行一个Substrate链,我们将使用此链作为部署智能合约的方法。
rust
Substrate和Ink依赖于rust。使用以下命令安装Rust。下面还包含两个命令,以确保您的Nightly Rust版本(最新可用的Rust版本)是最新的,以及Webassembly构建对Nightly Rust的支持:Ink合同编译为.wasm文件,因此作为Webassembly部署到Substrate链。
install rust and update environment
curl https://sh.rustup.rs -sSf | sh
source ~/.cargo/env
run rust updates and add WebAssembly target support
rustupupdatenightly
rustup targetaddwasm32-unknown-unknown--toolchain nightly
注意1:Cargo是Rust的包管理器,其包装称为Crates。
注意2:参考最后一个命令,target指的是rust项目目录中包含程序构建的目标文件夹。我们将在这里构建智能合约文件。
Substrate
使用以下命令安装Substrate:
Wasm utilities
Ink智能合约在上传到Substrate链之前会编译到WebAssembly中。 为此,我们需要安装一些实用程序:
We will install:
Binaryen
Compiler infrastructure and toolchain library for WebAssembly
Wabt
The WebAssembly Binary Toolkit
Parity Wasm Utils
Parity specific WebAssemply utilities */
MacOS
brew install binaryen
brew install wabt
cargo install pwasm-utils-cli --bin wasm-prune
Ubuntu
apt install binaryen
apt install wabt
cargo install pwasm-utils-cli --bin wasm-prune
Ink
我们现在可以通过箱子安装Ink, 运行以下命令:
本地运行substrate链
我们将在您的机器上运行的本地Substrate区块链上进行测试。 现在安装了Substrate,运行以下命令来初始化链:
--dev标志为您初始化开发区块链,仅在您的计算机本地化并初始化一些用户帐户。
此设置纯粹是为了测试目的;您可以将其视为与Truffle的Ganache程序,该程序运行本地基于以太坊的链,为测试目的进行了调整。
现在,您将注意到正在运行的节点正在验证新区块。 按CTRL + C或关闭终端窗口将停止节点执行,但链状态将持续存在,直到您下一次运行链。 在此注释中,如果您想要开始一个新链,请运行以下操作来清除您的链:
随着我们的Substrate链运行和Ink的准备,我们可以编写合同。在这样做之前,还需要提到编辑器支持。我个人发现Visual Studio Code是最好的编辑工作,不仅是Ink开发,还有Rust开发。 快速设置方法:
如果您还没有安装编辑器,请从此处安装VS Code安装RLS(Rust语言支持)扩展和WebAssembly扩展。 这可以直接在Extensions选项卡下的编辑器中完成,或按Shift + CMD + X直接跳转到它。
设置Ink项目
在安装了所有依赖项之后,现在让我们设置项目。
目前最简单的方法是安装Ink的“Hello World”合同,名为Flipper。 安装Flipper后,我们可以构建已经包含的内容,而不必担心配置和编译脚本 - 这些都在Flipper中提供。
注意:Substrate和Ink都处于快速发展阶段并且尚未完成全部功能,因此智能合约环境和智能合约代码本身很可能随着Parity越来越接近框架的最终版本而改变。
启动我们的Ink项目,请使用cargo获取Flipper:
fetch the Flipper Ink contract
cargo contractnewflipper
Flipper为我们提供了开始编写智能合约所需的项目样板,包括:
src / lib.rs中的一个简单的Flipper契约,它通过flip()方法简单地“翻转”true和false之间的布尔值,并使用get()方法在链上获取此值。我们将用NFT合同替换此文件。
Rust特定的Cargo.toml文件,概述项目依赖项和模块元数据,.gitignore文件和build.sh文件。 build.sh文件是我们运行以编译我们的智能合约,导致合同的已编译.wasm文件,合同的JSON抽象等等。我们将进一步探讨建成合约。
让我们把flipper改成一个更合适的名字:nftoken。修改以下内容:
/ flipper文件夹名称为/ nftoken
Cargo.toml:将[package] name和[lib] name更改为nftoken
build.sh:修改PROJNAME = nftoken
另外,确保我们有权运行nftoken / build.sh:
cdnftoken
chmod +x build.sh
最后,将/nftoken文件夹添加到vs代码工作区,我们就可以开始编写了。
关于Ink
Ink具有多个抽象级别,其中较高级别抽象较低级别。我们将使用最高级别,即语言级别或lang级别。这些级别也被分成了可以在这里探索的模块。
lang模块下面是模型和核心模块,分别侧重于中级抽象和核心实用程序。在核心模块下方,我们还可以期望专门用于创建和管理Ink智能合约的CLI。
虽然在撰写本文时几乎没有关于如何使用这些模块的内容,但我们确实有原始API文档可供浏览,包括核心模块和模型模块。如果您正在阅读本文,那么现在可以浏览这些文档,尽管我们下面的合同将利用其中一些API来展示如何通过不可互换的令牌合同在lang级别的上下文中使用它们。
考虑到这一点,接下来让我们来看看我们的lang派生合约的结构是什么样的,并将它与我们对基于Solidity的智能合约的期望进行比较。
智能合约架构
构造一个ink智能合约类似于solidity智能合约,其中我们期望的solidity的主要组成部分在ink中也是一致的:合同变量、事件、公共函数和私有函数,以及获取调用方地址的环境变量等等。
下面是NFoTek契约是如何构造的抽象:
//declaremodules
useparity::
...
//defineevents
enumEvent{
Mint { owner: AccountId,value: u64 },
}
...
//wrap entire contract inside the contract! macro
contract! {
// contractvariablesasastruct
structNFToken {
owner:storage::Value,
...
}
// compulsory deploy method thatisrun upon theinitialcontract
instantiation
impl DeployforNFToken {
fn deploy(&mutself, init_value: u64){}
}
//publiccontract methodsinan impl{}block
impl NFToken {
pub(external) fn total_minted(&self) -> u64 {}
...
}
//privatecontract methodsina separate impl{}block
imp NFToken {
fn is_token_owner(
&self,
of: &AccountId,
token_id: u64) -> bool {}
...
}
}
//testfunctions
modtests {
fn it_works() {}
...
}
让我们简要地访问这些部分,以及它们与我们对Solidity合同的期望有何不同。 Ink是基于Rust构建的,因此这里的所有语法都是有效的Rust语法。
我们的模块声明部分是我们将外部功能引入合同的地方,它与Solidity使用声明的性质类似。
// Ink
useink_core::{
env::{self,AccountId},
memory::format,
storage,
};
useink_lang::contract;
useparity_codec::{Decode,Encode};
// Solidity
interfaceContractName{
using SafeMathforuint256;
using AddressUtilsforaddress;
}
事件在Event枚举中声明,而使用Solidity我们分别定义事件,将每个事件键入事件:
// Ink
enumEvent {
Transfer {
from: AccountId,
to: AccountId,
token_id: u64
},
}
// Solidity
eventTransfer(
address indexedfrom,
address indexed to,
uint256 indexed _tokenId
);
如果solidity合同嵌入到接口块中,那么ink合同嵌入到合同中!宏。我们的事件在这个宏之外声明,而事件在solidity接口内声明。如下所述。
注意:rust中的宏是一个声明,表示包装表达式将被包围的语法块。宏在句法层面抽象,所以智能合约!宏正在用更多的语法包装其内容。
// Ink
// events
contract! {
// rest of contract
}
// Solidity
interfaceContractName{
// events
// rest of contract
}
使用Ink,我们的契约变量写在我们合同名称的结构中。 从Rust的HashMap类型派生的哈希映射代替Solidity的映射类型,提供key =>值列表。
Substrate如何存储值
在Substrate链上持久存储的任何数据称为外在数据,而Ink为我们提供了通过存储模块在链上存储外部数据的方法,存储模块位于语言的核心模块中。 换句话说,您计划在链上保留的所有合约变量都将使用存储中的类型。 相反,存储器模块也可用于在存储器上操作的数据结构。
另一方面,Solidity对此采用了不同的方法。 从Solidity 0.5开始,存储和内存引用类型被引入到函数参数或函数变量中,因此契约知道在哪里引用这些变量。 但是,对于Solidity中的合同变量,这不是必需的。
原始类型也可用,并且在两种语言中都是一致的; Rust使用u64,Solidity采用更详细的uint64类型声明。 总的来说,在两种语言之间实现相同的契约变量结构非常简单。
// Ink
structNFToken{
owner: storage::Value,
approvals: storage::HashMap,
}
// Solidity
address owner;
mapping (uint64 => address) approvals;
在上面的示例中,存储对象处理的值的类型通过尖括号传入,而不是通过类型的泛型。
初始化函数的概念存在于Ink和Solidity中,尽管以不同的方式实现。 使用Ink,我们在Deploy {}实现块中显式定义deploy()方法。 我们为此方法定义的参数代表了我们在初始化合同时发送的数据。 例如。 对于我们的不可替代的令牌,我们将提供初始数量的令牌:
// Inks initialisationfunction,deploy()
impl DeployforNFToken {
fn deploy(&mut self, init_value: u64) {
...
}
}
公共和私有方法也在impl块中定义,其中公共方法使用pub(外部)显式定义。 同样,在将此语法与Solidity的语法进行比较时,内部和外部用于定义私有或公共资源。
注意:在Rust中,函数,模块,特征和结构在默认情况下是私有的,并且必须使用pub关键字定义,以便它们可以从外部访问。 这里pub的(外部)扩展是特定于Ink的,并且必须包含公共Ink功能。
// public functions
impl NFToken {
pub(external)fntotal_minted(&self) -> u64{}
}
// private functions
impl NFToken {
fnmint_impl(
&mut self,
receiver: AccountId,
value: u64) ->bool{
}
}
同样,我们将私有函数和公共函数分开放在单独的impl块中,并为已定义的公共函数包含pub(external)。
作为合同的最后一个构建块,定义了一个测试模块,在测试我们的函数时断言各种条件。 在测试模块中,我们可以测试我们的合同逻辑,而无需编译并将其部署到Substrate链,从而可以快速解决错误并验证合同是否按预期工作。
接下来
我们现在已经讨论了Ink智能合约的构建模块。 在本系列的下一部分中,我们将更深入地探讨非可替代令牌智能合约的功能,理解所使用的Rust设计模式以及它们如何与我们的智能合约逻辑相结合。 然后我们将介绍构建智能合约并将其部署到本地Substrate链的过程,并使用Polkadot JS测试其功能。
作者:Ross Bulat