17个版本 (7个稳定版)

4.0.0-alpha.12022年8月24日
3.4.0 2022年10月21日
3.3.1 2022年8月9日
3.3.0 2022年6月22日
3.0.0-rc22020年10月22日

#24 in #parity-wasm

Download history 212/week @ 2024-03-11 129/week @ 2024-03-18 137/week @ 2024-03-25 267/week @ 2024-04-01 142/week @ 2024-04-08 198/week @ 2024-04-15 177/week @ 2024-04-22 161/week @ 2024-04-29 150/week @ 2024-05-06 126/week @ 2024-05-13 143/week @ 2024-05-20 144/week @ 2024-05-27 127/week @ 2024-06-03 122/week @ 2024-06-10 167/week @ 2024-06-17 138/week @ 2024-06-24

567 每月下载量
用于 26 个crate(5个直接使用)

Apache-2.0

360KB
8K SLoC

ink!

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

linux codecov coveralls loc stack-exchange

squink,ink!吉祥物ink!是一个内嵌领域特定语言(eDSL),用于在Rust中编写基于Substrate框架的区块链智能合约。ink!合约将被编译成WebAssembly。


初学者指南  •   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合约的特质并实现。
  • erc721Erc721 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(storage)] struct定义上。 定义ink!存储结构。每个合约只能有一个ink!存储定义。
#[ink(message)] 适用于方法。 将ink!存储结构的方法标记为消息,使其可用于API调用合约。
#[ink(constructor)] 适用于方法。 将ink!存储结构的方法标记为构造函数,使其可用于API实例化合约。
#[ink(event)] struct定义上。 定义ink!事件。合约可以定义多个此类ink!事件。
#[ink(anonymous)] 适用于ink!事件。 指示ink!代码生成器将ink!事件视为匿名,在发出时省略事件签名作为主题。类似于Solidity中的匿名事件。
#[ink(topic)] 适用于ink!事件字段。 指示ink!代码生成器为给定字段提供一个主题哈希。每个ink!事件只能有有限数量的此类主题字段。与Solidity中的索引事件参数类似。
#[ink(payable)] 适用于ink!消息。 允许在ink!消息的调用中接收值。ink!构造函数是隐式可支付的。
#[ink(selector=S:u32)] 适用于ink!消息和ink!构造函数。 指定为标记实体指定具体的调度选择器。这允许合约作者精确控制其API的选择器,使得在不破坏的情况下重命名其API成为可能。
#[ink(selector= _)] 适用于ink!消息。 指定一个后备消息,如果没有其他ink!消息与选择器匹配,则调用该消息。
#[ink(namespace=N:string)] 适用于ink!特性实现块。 更改特徵实现中所有ink!消息和ink!构造函数的结果选择器。允许在具有重叠消息或构造函数名称的特性实现之间进行区分。请谨慎使用!
#[ink(impl)] 适用于ink!实现块。 通知ink!代码生成器,某些实现块即使不包含任何ink!消息或ink!构造函数也应允许访问ink!内部。

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

特征定义

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

链下测试

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

开发者文档

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

crate 文档 描述
ink_lang ink!公开的语言功能。有关您可以在#[ink::contract]中使用属性的详细描述,请参阅此处
ink_storage ink!中可用的数据结构。
ink_env 与智能合约Wasm执行器交互的低级别接口。还包含链下测试API
ink_prelude 用于访问alloc crate类型的no_std和std的通用API。

社区徽章

常规设计

Built with ink!

[![Built with ink!](https://raw.githubusercontent.com/paritytech/ink/master/.images/badge.svg)](https://github.com/paritytech/ink)

平面设计

Built with 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许可。

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

依赖关系

约2.5MB
约52K SLoC