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

ink!是一个用于在Rust中编写区块链智能合约的eDSL，这些合约将被编译成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!宏和属性概述
  • 入口点
  • 特质定义
  • 链外测试
• 开发者文档
• 社区徽章
  • 常规设计
  • 扁平设计
• 贡献
• 许可

玩转它

要开始，请查看我们文档中的入门页面。

如果您想设置本地环境，可以使用我们的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的文件夹在您的工作目录中。该文件夹包含一个scaffold 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 文件包含 exactly 这段代码。运行 cargo contract build 来构建您的第一个 ink! 智能合约。

示例

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

其中一些最有趣的包括

• basic_contract_ref — 实现跨合约调用。
• trait-erc20 — 定义了 Erc20 合约的 trait 并实现了它。
• 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级别的文档本身，那么这些是相关的链接

Crate	Docs	描述
ink		ink!公开的语言功能。有关您可以在#[ink::contract]中使用属性的详细描述，请参阅此处。
ink_storage		ink!中可用的数据结构。
ink_env		与智能合同Wasm执行器交互的底层接口。还包含链下测试API。
ink_prelude		为无_std 和 std 提供通用的 API 来访问 alloc crate 类型。

社区徽章

常规设计

[![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许可协议的约束。

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