Parity 的 ink! 智能合约编写工具

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

初学者指南  •   ink! 文档门户  •   开发者文档

更多相关链接

• Substrate Stack Exchange — 回答 ink! 问题的论坛
• cargo-contract — ink! 合约的 CLI 工具
• 合约 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的并行链，支持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文件夹中看到一个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 的文件。

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

工作原理

• 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		用于访问alloc crate类型的no_std和std的常用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许可。

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