发布说明

发布说明和未发布的更改可以在 CHANGELOG 中找到

示例

使用 #[near] 包装一个结构体，并生成与 NEAR 区块链兼容的智能合约

use near_sdk::{near, env};

#[near(contract_state)]
#[derive(Default)]
pub struct StatusMessage {
    records: HashMap<AccountId, String>,
}

#[near]
impl StatusMessage {
    pub fn set_status(&mut self, message: String) {
        let account_id = env::signer_account_id();
        self.records.insert(account_id, message);
    }

    pub fn get_status(&self, account_id: AccountId) -> Option<String> {
        self.records.get(&account_id).cloned()
    }
}

特性

可单元测试

使用 near-sdk 很容易编写单元测试

#[test]
fn set_get_message() {
    let mut contract = StatusMessage::default();
    contract.set_status("hello".to_string());
    assert_eq!("hello".to_string(), contract.get_status("bob_near".to_string()).unwrap());
}

以通常的方式运行单元测试

cargo test --package status-message

异步跨合约调用

异步跨合约调用允许并行执行多个合约，并在另一个合约上聚合。 env 提供以下方法

• promise_create -- 在某个合约上安排函数执行；
• promise_then -- 函数执行后，将回调附加到当前合约；
• promise_and -- 组合器，允许在执行回调之前同时等待多个承诺；
• promise_return -- 将承诺的执行结果视为当前函数的结果。

参照 examples/cross-contract-high-level 查看跨合约调用的各种用法，包括在合约内部执行的 系统级操作，如余额转移（其他系统级操作的例子包括：创建账户、创建/删除访问密钥、合约部署等）。

初始化方法

我们可以定义一个初始化方法来初始化合约的状态。代码 #[init] 确保合约尚未初始化（合约状态不存在），否则会引发 panic。

#[near]
impl StatusMessage {
    #[init]
    pub fn new(user: String, status: String) -> Self {
        let mut res = Self::default();
        res.records.insert(user, status);
        res
    }
}

即使你有初始化方法，你的智能合约仍然预期会继承 Default 特性。如果你想不禁用默认初始化，则可以像这样禁止它

impl Default for StatusMessage {
    fn default() -> Self {
        near_sdk::env::panic_str("Contract should be initialized before the usage.")
    }
}

您还可以通过使用 near_sdk::PanicOnDefault 辅助宏来禁止 Default 特性初始化。例如。

#[near(contract_state)]
#[derive(PanicOnDefault)]
pub struct StatusMessage {
    records: HashMap<String, String>,
}

可支付方法

我们可以允许方法接受与函数调用一起的代币转移。这样做是为了使合约能够定义在它们被使用时需要支付的代币费用。默认情况下，方法不是可支付的，如果在调用期间有人尝试向它们转账代币，它们会引发 panic。这是出于安全考虑，以防有人意外地在函数调用期间转账代币。

要声明一个可支付方法，只需使用 #[payable] 装饰器

#[payable]
pub fn my_method(&mut self) {
...
}

私有方法

通常，当一个合约需要远程跨合约调用的回调时，这个回调方法应该只能由合约本身调用。这是为了避免其他人调用它并破坏状态。常见的模式是使用一个断言来验证直接调用者（前驱账户 ID）与合约的账户（当前账户 ID）相匹配。宏 #[private] 通过将其简化为一个单行宏，并提高可读性。

要声明一个私有方法，请使用 #[private] 装饰器

#[private]
pub fn my_method(&mut self) {
...
}
/// Which is equivalent to

pub fn my_method(&mut self ) {
    if near_sdk::env::current_account_id() != near_sdk::env::predecessor_account_id() {
        near_sdk::env::panic_str("Method my_method is private");
    }
...
}

现在，只有合约的账户本身可以调用这个方法，无论是直接还是通过承诺。

先决条件

要开发 Rust 合约，你需要

• 安装 Rustup

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

• 将 wasm 目标添加到您的工具链中

rustup target add wasm32-unknown-unknown

编写 Rust 合约

您可以参考 examples/status-message crate，它展示了一个简单的 Rust 合约。

一般工作流程如下

1. 创建一个 crate 并配置 Cargo.toml，类似于 examples/status-message/Cargo.toml 中的配置；

2. Crate 需要有一个 pub 结构体，它将代表智能合约本身

   • 该结构体需要实现 Default 特性，NEAR 将在合约首次使用时使用它来创建合约的初始状态；

   以下是一个智能合约结构体的示例

   use near_sdk::{near, env};
   
   #[near(contract_state)]
   #[derive(Default)]
   pub struct MyContract {
       data: HashMap<u64, u64>
   }
   

3. 定义NEAR将公开为智能合约方法的函数

   • 您可以自由地为结构体定义任何方法，但只有公开的方法才会作为智能合约方法公开；
   • 方法需要使用 &self、&mut self 或 self；
   • 使用 #[near] 宏装饰 impl 部分。所有 M.A.G.I.C.（宏自动生成注入代码）都在这里发生；
   • 如果您需要使用区块链接口，例如获取当前账户ID，则可以使用 env::* 访问；

   以下是一个智能合约方法的示例

   #[near]
   impl MyContract {
       pub fn insert_data(&mut self, key: u64, value: u64) -> Option<u64> {
           self.data.insert(key)
       }
       pub fn get_data(&self, key: u64) -> Option<u64> {
           self.data.get(&key).cloned()
       }
   }
   

构建Rust合约

cargo-near

cargo-near 是构建和部署Rust合约的简单且推荐的方式。

安装

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/near/cargo-near/releases/latest/download/cargo-near-installer.sh | sh

irm https://github.com/near/cargo-near/releases/latest/download/cargo-near-installer.ps1 | iex

npm install cargo-near

cargo install cargo-near

$ git clone https://github.com/near/cargo-near
$ cargo install --path cargo-near

用法

查看 cargo near --help 获取可用命令的完整列表，或运行 cargo near 进入交互模式。每个单独的命令也都有带有 --help 标志的帮助，例如 cargo near build --help。

cargo near

启动交互模式，允许探索所有可用命令。

cargo near build

构建NEAR智能合约及其 ABI（在包含合约的Cargo.toml目录中）。

cargo near create-dev-account

指导您在 测试网 上创建新的NEAR账户。

cargo near deploy

构建智能合约（相当于 cargo near build）并指导您将其部署到区块链。

使用 cargo build

RUSTFLAGS='-C link-arg=-s' cargo build --target wasm32-unknown-unknown --release

使用可重复构建构建

由于WebAssembly编译器将大量调试信息包含到二进制文件中，结果二进制文件可能在不同的机器上有所不同。为了能够以可重复的方式编译二进制文件，我们添加了一个Dockerfile，它允许编译二进制文件。

使用 contract-builder

NEAR合约标准

near-contract-standards 包 提供了NEAR合约标准的一套接口和实现

• 可升级性
• 可替代代币（NEP-141）。查看 示例用法
• 非可替代代币（NEP-171）。查看 示例用法

版本控制

语义版本控制

此包遵循 Cargo的semver指南。

无论如何都要避免状态破坏性更改（任何数据类型的低级序列化格式）。如果发生此类更改，它将伴随一个主版本，并且会伴随着编译器错误。如果您遇到这种情况，请提交一个问题！

MSRV

目前最低支持的Rust版本为1.76。如果需要发布一个需要提高Rust工具链的安全补丁版本，则无法保证会维持这个版本。

贡献

如果您有兴趣贡献，请查看贡献指南。