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

ink! 是一种 嵌入式领域特定语言，用于在 Rust 中编写基于 Substrate 框架构建的区块链的智能合约。ink! 合约被编译成 WebAssembly。

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

更多相关链接

• Substrate Stack Exchange ‒ 回答 ink! 问题的论坛
• cargo-contract ‒ ink! 合约的 CLI 工具
• Contracts UI ‒ 合约实例化和交互的前端
• Substrate 合约节点 ‒ 包含智能合约功能的简单 Substrate 区块链
• 我们在 Matrix 和 Discord (在 ink_smart-contracts 频道) 上发布公告。

目录

• 玩转它
• 用法
• 你好，世界！ — 翻转者
• 示例
• 工作原理
• ink! 宏和属性概述
  • 入口点
  • 特质定义
  • 链下测试
• 开发者文档
• 社区徽章
• 贡献
• 许可协议

玩转它

如果您想本地搭建环境，可以使用我们的substrate-contracts-node进行快速入门。这是一个简单的Substrate区块链，其中包含了用于智能合约功能的Substrate模块——contracts提货场（更多内容请见工作原理）。

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

对于这两种类型的链，可以使用合约UI来实例化合约并将其与链交互。

用法

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

我们还建议安装cargo-contract。这是一个CLI工具，可以帮助设置和管理使用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 +nightly contract build

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

你好，世界！ — 翻转者

Flipper合约是一个简单的合约，只包含一个bool值。它提供了以下方法：

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

以下展示了使用ink!的ink_lang版本的代码。

use ink_lang as 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::*;
        use ink_lang as ink;

        #[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!编写的示例。

其中一些有趣的示例

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

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

cargo contract build

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

有关如何将此文件上传到链上的信息，请参阅玩转它部分或我们的智能合约研讨会。

工作原理

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

ink! 宏和属性概述

入口点

在带有 #[ink::contract] 注解的模块中，这些属性是可用的

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

特质定义

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

链下测试

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

开发者文档

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

库	文档	描述
ink_lang		ink!公开的语言特性。有关在#[ink::contract]中使用属性的详细描述，请参阅这里。
ink_storage		ink!中的数据结构。
ink_env		与智能合约Wasm执行器交互的低级接口。包含链下测试API。
ink_prelude		用于无_std和std访问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授权。

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