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

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

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

更多相关链接

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

目录

• 目录
• 动手玩一玩
• 用法
• Hello, World! —— The Flipper
• 示例
• 它是如何工作的
• ink! 宏和属性概述
  • 入口点
  • 特质定义
  • 链外测试
• 开发者文档
• 社区徽章
  • 常规设计
  • 平面设计
• 贡献
• 许可协议

动手玩一玩

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

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

我们还在 Rococo 上有一个名为 "Contracts" 的实时测试网。Rococo 是一个基于 Substrate 的 parachain，支持 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 文件夹中获得一个 target/flipper.wasm 文件，一个 flipper.json 文件和一个 <contract-name>.contract 文件。该 .contract 文件将 Wasm 和元数据合并为单个文件，并在实例化合约时需要使用。

Hello, World! —— The Flipper

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] 注解的模块中，这些属性可用

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

特质定义

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

链外测试

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

开发者文档

我们有一个非常全面的文档门户，但如果您正在寻找有关crate级别的文档本身，则以下为相关链接

包	文档	描述
ink		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许可。

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