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

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

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

更多相关链接

• Substrate Stack Exchange — 问答论坛，解决您的 ink! 问题
• cargo-contract — ink! 合约的 CLI 工具
• 合约 UI — 合约实例化和交互的前端
• Substrate 合约节点 — 包含智能合约功能的简单 Substrate 区块链
• Awesome ink! - Parity ink! 的精选项目列表！
• 我们在 Matrix 和 Discord（在 ink_smart-contracts 频道）发布公告。

目录

• 目录
• 动手试一试
• 用法
• 你好，世界！ —— 翻转者
• 示例
• 它是如何工作的
• ink! 宏和属性概述
  • 入口点
  • 特质定义
  • 链外测试
• 开发者文档
• 社区徽章
  • 常规设计
  • 扁平设计
• 贡献
• 许可

动手试一试

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

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

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

可以使用 Contracts 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 contract build

结果，您将在合约的 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 合约的 trait 并实现了它。
• erc721 — Erc721 NFT 令牌的一个示例实现。
• dns — 一个简单的 DomainNameService 智能合约。
• …等等，只需在文件夹里翻找一下 🙃。

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

cargo contract build

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

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

它是如何工作的

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

ink! 宏和属性概述

入口点

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

有关这些以及更多详细信息，请参阅[此处](https://paritytech.github.io/ink/ink/attr.contract.html)以及有关#[ink::contract]宏的详细信息。

特质定义

使用#[ink::trait_definition]来定义您自己的特质定义，然后ink!智能合约可以实现这些定义。例如，请参阅[此处](https://github.com/paritytech/ink-examples/blob/v4.0.1/trait-erc20/lib.rs#L20-L22)合同了解如何使用它，或参阅[此处](https://paritytech.github.io/ink/ink/attr.trait_definition.html)的文档以获取详细信息。

链外测试

#[ink::test]过程宏可以启用链下测试。例如，请参阅[此处](https://github.com/paritytech/ink-examples/blob/v4.0.1/erc20/lib.rs#L276-L277)合同了解如何使用这些，或参阅[此处](https://paritytech.github.io/ink/ink/attr.test.html)的文档以获取详细信息。

开发者文档

我们有一个[非常全面的文档门户](https://use.ink)，但如果您正在寻找crate级别的文档本身，那么以下是一些相关链接

存储库	文档	描述
ink		ink!公开的语言功能。有关您可以在#[ink::contract]中使用属性的详细描述，请参阅[此处](https://paritytech.github.io/ink/ink/attr.contract.html)。
ink_storage		ink!中可用的数据结构。
ink_env		与智能合约Wasm执行器交互的低级接口。还包含[链下测试API](https://paritytech.github.io/ink/ink_env/test/index.html)。
ink_prelude		no_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)

贡献

有关更多信息，请访问我们的[贡献指南](https://github.com/paritytech/ink/blob/011b775bd238600edc36ea3b67c9b9edd325a3c9/crates/ink/macro/CONTRIBUTING.md)。

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

许可

本存储库中的全部代码均根据[Apache License 2.0](https://github.com/paritytech/ink/blob/011b775bd238600edc36ea3b67c9b9edd325a3c9/crates/ink/macro/LICENSE)许可。

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