Parity 的 ink! 用于编写智能合约

ink! 是一个用于在基于 Substrate 框架的区块链上编写 Rust 智能合约的 eDSL。ink! 合约编译成 WebAssembly。

初学者指导教程  •   ink! 文档门户  •   开发者文档

更多相关链接

• Substrate Stack Exchange — 获得ink!问题的答案的论坛
• cargo-contract — ink! 合约的 CLI 工具
• Contracts UI — 合约实例化和交互的前端
• Substrate Contracts Node - 简单的包含智能合约功能的Substrate区块链
• Awesome ink! - Parity ink!的优秀项目列表
• 我们在Matrix和Discord（在ink_smart-contracts频道）发布公告。

目录

• 目录
• 玩转ink!
• 用法
• 你好，世界！- 翻转器
• 示例
• 工作原理
• ink!宏和属性概述
  • 入口点
  • 特质定义
  • 链外测试
• 开发者文档
• 社区徽章
  • 常规设计
  • 扁平设计
• 贡献
• 许可协议

玩转ink!

开始的最佳方式是查看我们的文档中的入门页面。

如果您想进行本地设置，可以使用我们的substrate-contracts-node快速入门。这是一个简单的Substrate区块链，包含智能合约功能的Substrate模块——contracts组件（更多信息请见工作原理）。

我们还在Rococo上有一个名为“Contracts”的实时测试网。Rococo是一个基于Substrate的 parachain，支持ink!智能合约。有关使用此测试网的进一步说明，请参阅我们的文档。

可以使用Contracts UI将合约实例化到链上并与之交互。

用法

编译智能合约的前提是已安装Rust和Cargo。以下是安装指南。

我们还建议安装cargo-contract。它是一个命令行工具，有助于设置和管理用ink!编写的WebAssembly智能合约。

cargo install cargo-contract --force

使用--force确保您更新到最新的cargo-contract版本。

要初始化一个新的ink!项目，可以使用以下命令

cargo contract new flipper

这将在您的工作目录中创建一个名为flipper的文件夹。该文件夹包含一个支架Cargo.toml和一个lib.rs，它们都包含使用ink!所需的必要构建块。

lib.rs包含我们的hello world合约——Flipper，我们将在下一节中解释。

为了构建合约，只需在flipper文件夹中执行以下命令

cargo contract build

结果，您将在合约的target文件夹中得到一个target/flipper.wasm文件，一个flipper.json文件和一个<contract-name>.contract文件。该.contract文件将Wasm和元数据合并到一个文件中，并在实例化合约时使用。

你好，世界！- 翻转器

Flipper合约是一个简单的合约，仅包含一个bool值。

它提供了以下方法

• 将其值从true翻转到false（反之亦然）
• 并返回当前状态。

下面您可以看到使用ink!的代码。

#[ink::contract]
mod flipper {
    /// The storage of the flipper contract.
    #[ink(storage)]
    pub struct Flipper {
        /// The single `bool` value.
        value: bool,
    }

    impl Flipper {
        /// Instantiates a new Flipper contract and initializes
        /// `value` to `init_value`.
        #[ink(constructor)]
        pub fn new(init_value: bool) -> Self {
            Self {
                value: init_value,
            }
        }

        /// Flips `value` from `true` to `false` or vice versa.
        #[ink(message)]
        pub fn flip(&mut self) {
            self.value = !self.value;
        }

        /// Returns the current state of `value`.
        #[ink(message)]
        pub fn get(&self) -> bool {
            self.value
        }
    }

    /// Simply execute `cargo test` in order to test your contract
    /// using the below unit tests.
    #[cfg(test)]
    mod tests {
        use super::*;

        #[ink::test]
        fn it_works() {
            let mut flipper = Flipper::new(false);
            assert_eq!(flipper.get(), false);
            flipper.flip();
            assert_eq!(flipper.get(), true);
        }
    }
}

我们示例文件夹中的flipper/src/lib.rs文件包含正好这样的代码。运行cargo contract build来构建您的第一个ink!智能合约。

示例

在examples仓库中，您可以找到许多用ink!编写的示例。

其中一些最有趣的

• basic_contract_ref - 实现跨合约调用。
• trait-erc20 - 定义了Erc20合约的特质并实现了它。
• erc721 - Erc721 NFT代币的示例实现。
• dns - 一个简单的DomainNameService智能合约。
• …还有更多，只需翻阅文件夹即可 🙃。

要构建单个示例，请导航到示例的根目录，并运行

cargo contract build

现在您应该在合约的target文件夹中有一个<name>.contract文件。

有关如何将此文件上传到链的信息，请参阅动手玩一玩部分或我们的智能合约工作坊。

工作原理

• Substrate的模块化实体运行时聚合框架(FRAME)包含一个模块，该模块实现了一个API，该API为智能合约需要的一些典型函数（存储、查询账户信息等）提供支持。这个模块被称为contracts。
• contracts模块要求智能合约以Wasm blob的形式上传到区块链。
• ink!是一种针对contracts暴露的API的智能合约语言。因此，ink!合约被编译为Wasm。
• 当执行cargo contract build时，会创建一个额外的文件<contract-name>.json。它包含有关合约提供的方法等信息，以便其他人可以调用。

ink!宏和属性概述

入口点

在用#[ink::contract]注解的模块中，以下属性是可用的

有关这些的更详细描述以及有关#[ink::contract]宏的详细信息，请参阅这里。

特质定义

使用#[ink::trait_definition]来定义您自己的特性定义，然后ink!智能合约可以实施这些定义。例如，请参阅examples/trait-erc20合约，了解如何使用它或文档以获取详细信息。

链外测试

#[ink::test]过程宏启用链下测试。例如，请参阅examples/erc20合约，了解如何使用这些或文档以获取详细信息。

开发者文档

我们有一个非常全面的文档门户，但如果您正在寻找有关crate级别的文档本身，那么这些是相关的链接

crate	文档	描述
ink		ink!暴露的语言功能。有关您可以在#[ink::contract]中使用属性的详细描述，请参阅这里。
ink_storage		ink!中可用的数据结构。
ink_env		与智能合约Wasm执行器交互的底层接口。包含链下测试API。
ink_prelude		用于访问alloc crate类型的通用API。

社区徽章

常规设计

[![Built with ink!](https://raw.githubusercontent.com/paritytech/ink/master/.images/badge.svg)](https://github.com/paritytech/ink)

扁平设计

[![Built with ink!](https://raw.githubusercontent.com/paritytech/ink/master/.images/badge_flat.svg)](https://github.com/paritytech/ink)

贡献

有关更多信息，请访问我们的贡献指南。

请使用位于scripts/check-*目录下的脚本，以在工作区或所有示例上运行检查。请在提交PR之前执行此操作。

许可协议

本存储库中所有代码均采用Apache License 2.0许可。

如果您对我们的产品许可有任何疑问，请联系我们。