翻译作者:https://twitter.com/ganxiaolong5
solana-test-validator
命令运行 本地测试验证节点
cargo build-bpf
和 solana program deploy
命令在本地构建和部署程序solana logs
命令查看程序日志在这门课程中,我们迄今为止一直使用 Solana Playground 来开发和部署 Solana 程序。虽然它是一个很好的工具,但对于某些复杂的项目,你可能更喜欢设置一个本地开发环境。这可能是为了使用 Solana Playground 不支持的 crates,充分利用你创建的自定义脚本或工具,或仅仅是出于个人偏好。
有了这个前提,这节课将略有不同。与其详细介绍如何编写程序或与 Solana 网络交互,这节课将主要关注设置本地开发环境这个不那么引人注目的任务。
为了在计算机上构建、测试和部署 Solana 程序,你需要安装 Rust 编译器和 Solana 命令行界面 (Command Line Interface,CLI)。我们将首先指导你完成这些安装过程,然后介绍如何使用刚刚安装的工具。
以下是编写时安装 Rust 和 Solana CLI 的步骤。到你阅读此内容时,可能已经有所更改,因此如果遇到问题,请查阅各自的官方安装页面:
如果你使用的是 Windows 计算机,建议使用 Windows Subsystem for Linux (WSL) 来构建 Solana 程序。
打开一个管理员权限的 PowerShell 或 Windows 命令提示符,并检查 Windows 版本。
winver
如果你的 Windows 版本是 2004 或更高版本(Build 19041 或更高版本),或者使用的是 Windows 11,请运行以下命令。
wsl --install
如果你使用的是较旧版本的 Windows,请按照旧版本 Windows 安装指南进行操作。
你可以从微软的安装 WSL 文档中了解更多信息。
接下来,下载 Ubuntu。Ubuntu 提供一个终端,允许你在 Windows 计算机上运行 Linux。这将是你运行 Solana CLI 命令的地方。
接下来,在 Ubuntu 终端中打开,并使用以下命令下载适用于 WSL 的 Rust。你可以从文档中了解更多关于 Rust 的信息。
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
现在我们准备好在 Linux 上下载 Solana CLI 了。在 Ubuntu 终端中运行以下命令。你可以从文档中了解更多关于 Solana CLI 的信息。
sh -c "$(curl -sSfL https://release.solana.com/stable/install)"
首先,按照 https://www.rust-lang.org/tools/install 的说明下载 Rust。
接下来,在终端中运行以下命令下载 Solana CLI。
sh -c "$(curl -sSfL https://release.solana.com/stable/install)"
你可以阅读有关Solana CLI 的更多信息。
Solana CLI 是一个命令行界面工具,提供了一系列用于与 Solana Cluster 交互的命令。
在本课程中,我们将介绍一些最常见的命令,但你始终可以通过运行 solana --help
查看所有可能的 Solana CLI 命令列表。
Solana CLI 存储了一些配置设置,这些设置会影响某些命令的行为。你可以使用以下命令查看当前的配置:
solana config get
solana config get
命令将返回以下信息:
Config File
- Solana CLI 文件在计算机上的位置RPC URL
- 你使用的节点,将你连接到 localhost、Devnet 或 MainnetWebSocket URL
- 用于监听你所针对的 Cluster 事件的 WebSocket(在设置 RPC URL
时计算)Keypair Path
- 运行 Solana CLI 子命令时使用的密钥对路径Commitment
- 提供网络确认(confirmation)的度量,并描述区块在某一时刻已最终确认(finalized)的程度你可以随时使用 solana config set
命令,后跟你想要更新的设置,更改 Solana CLI 的配置。
最常见的更改将是针对的 Cluster。使用 solana config set --url
命令更改 RPC URL
。
solana config set --url localhost
solana config set --url devnet
solana config set --url mainnet-beta
类似地,你可以使用 solana config set --keypair
命令更改 Keypair Path
。然后,当运行命令时,Solana CLI 将使用指定路径上的密钥对。
solana config set --keypair ~/<FILE_PATH>
通常,为了进行测试和调试,你会发现运行本地验证节点比部署到 Devnet 更有帮助。
你可以使用 solana-test-validator
命令运行本地测试验证器。此命令创建一个持续运行的进程,需要在其自己的命令行窗口中运行。
通常,同时打开一个新控制台并运行 solana logs
命令,可以帮助你观察测试验证节点相关的日志。这将创建另一个持续运行的进程,会流式传输与你配置的 Cluster 相关的日志。
如果 CLI 配置指向 localhost
,则日志将始终与你创建的测试验证器相关联,但你也可以从其他 Cluster(如 Devnet 和 Mainnet Beta)中流式传输日志。当从其他 Cluster 流式传输日志时,你需要在命令中包含一个程序 ID,以限制你看到的日志仅为特定程序的日志。
你可以使用 solana-keygen new --outfile
命令生成新的密钥对,后跟存储密钥对的文件路径。
solana-keygen new --outfile ~/<FILE_PATH>
有时,你可能需要检查配置指向的是哪个密钥对。要查看在 solana config
中设置的当前密钥对的 publickey
,请使用 solana address
命令。
solana address
要查看在 solana config
中设置的当前密钥对的 SOL 余额,请使用 solana balance
命令。
solana balance
要在 Devnet 或 localhost 上空投 SOL,请使用 solana airdrop
命令。请注意,在 Devnet 上,每次空投限制为 5 SOL。
solana airdrop 5
在本地环境中开发和测试程序时,你可能会遇到以下原因导致的错误:
到目前为止,我们介绍的 CLI 命令应该可以帮助你迅速解决这些问题。
尽管 Solana Playground 非常有帮助,但很难超越你自己的本地开发环境的灵活性。随着你构建更复杂的程序,你可能最终会将它们与在本地环境中同样在开发中的一个或多个客户端集成。当你在本地编写、构建和部署程序时,程序和客户端之间的测试通常更简单。
要创建一个用于编写 Solana 程序的新 Rust 包,你可以使用 cargo new --lib
命令,后跟你想要创建的新目录的名称。
cargo new --lib <PROJECT_DIRECTORY_NAME>
此命令将创建一个新目录,其名称为你在命令末尾指定的名称。这个新目录将包含一个描述该包的 Cargo.toml
清单文件(manifest file)。
清单文件包含元数据,如名称、版本和依赖项(crates)。要编写 Solana 程序,你需要更新 Cargo.toml
文件,将 solana-program
添加为依赖项。你可能还需要添加下面显示的 [lib]
和 crate-type
行。
[package]
name = "<PROJECT_DIRECTORY_NAME>"
version = "0.1.0"
edition = "2021"
[features]
no-entrypoint = []
[dependencies]
solana-program = "~1.8.14"
[lib]
crate-type = ["cdylib", "lib"]
在这一点上,你可以开始在 src
文件夹中编写程序。
当需要构建 Solana 程序时,可以使用 cargo build-bpf
命令。
cargo build-bpf
该命令的输出将包含部署程序的说明,看起来类似于:
To deploy this program:
$ solana program deploy /Users/James/Dev/Work/solana-hello-world-local/target/deploy/solana_hello_world_local.so
The program address will default to this keypair (override with --program-id):
/Users/James/Dev/Work/solana-hello-world-local/target/deploy/solana_hello_world_local-keypair.json
当你准备部署程序时,使用 cargo build-bpf
输出的 solana program deploy
命令。这将把你的程序部署到你 CLI 配置中指定的 Cluster。
solana program deploy <PATH>
让我们通过构建和部署我们在Hello World 课程中创建的 "Hello World!" 程序来进行实践。
我们将全部在本地进行,包括部署到本地测试验证节点。在开始之前,请确保你已安装了 Rust 和 Solana CLI。如果尚未设置,请参考概述中的说明。
让我们从创建一个新的 Rust 项目开始。运行下面的 cargo new --lib
命令。随意用你自己的目录名称替换。
cargo new --lib solana-hello-world-local
记得更新 Cargo.toml
文件,将 solana-program
添加为依赖项,并确保 crate-type
行已经存在。
[package]
name = "solana-hello-world-local"
version = "0.1.0"
edition = "2021"
[dependencies]
solana-program = "~1.8.14"
[lib]
crate-type = ["cdylib", "lib"]
接下来,使用下面的“Hello World!”程序更新 lib.rs
。当调用程序时,该程序将简单地打印“Hello, world!”到程序日志。
use solana_program::{
account_info::AccountInfo,
entrypoint,
entrypoint::ProgramResult,
pubkey::Pubkey,
msg
};
entrypoint!(process_instruction);
pub fn process_instruction(
program_id: &Pubkey,
accounts: &[AccountInfo],
instruction_data: &[u8]
) -> ProgramResult{
msg!("Hello, world!");
Ok(())
}
在编写好程序之后,让我们确保我们的 Solana CLI 配置指向 localhost,使用 solana config set --url
命令。
solana config set --url localhost
接下来,使用 solana config get
命令检查 Solana CLI 配置是否已更新。
solana config get
最后,在一个单独的终端窗口中运行本地测试验证器。运行 solana-test-validator
命令。只有当我们的 RPC URL
设置为 localhost 时,才需要执行此操作。
solana-test-validator
现在我们准备好构建和部署我们的程序了。通过运行 cargo build-bpf
命令来构建程序。
cargo build-bpf
现在让我们部署程序。运行 cargo build-bpf
输出的 solana program deploy
命令。
solana program deploy <PATH>
solana program deploy
将输出程序的 Program ID
。你现在可以在Solana Explorer上查找已部署的程序(对于 localhost,请选择“Custom RPC URL”作为 Cluster)。
在调用我们的程序之前,打开一个单独的终端,并运行 solana logs
命令。这将允许我们在终端中查看程序的日志。
solana logs <PROGRAM_ID>
在测试验证节点仍在运行的情况下,尝试使用此客户端脚本调用程序。
在 index.ts
中用刚刚部署的程序的程序 ID 替换原有的程序 ID,然后运行 npm install
,接着运行 npm start
。这将返回一个 Solana Explorer URL。将该 URL 复制到浏览器中以在 Solana Explorer 上查找交易,并检查是否将“Hello, world!”打印到程序日志中。或者,你也可以在运行 solana logs
命令的终端中查看程序日志。
恭喜!你刚刚从本地开发环境中创建并部署了你的第一个 Solana 程序。
尝试创建一个新程序,将自己的消息打印到程序日志中。这次将程序部署到 Devnet,而不是 localhost。
记得使用 solana config set --url
命令将 RPC URL
更新到 Devnet。
你可以使用与实验相同的客户端脚本调用程序,只要将 connection
和 Solana Explorer URL 都更新为指向 Devnet 而不是 localhost。
let connection = new web3.Connection(web3.clusterApiUrl("devnet"));
console.log(
`Transaction: https://explorer.solana.com/tx/${transactionSignature}?cluster=devnet`
);
你还可以打开一个单独的命令行窗口,并使用 solana logs | grep "<PROGRAM_ID> invoke" -A <NUMBER_OF_LINES_TO_RETURN>
。在 Devnet 上使用 solana logs
时,必须指定程序 ID。否则,solana logs
命令将从 Devnet 返回一系列恒定的日志流。例如,你可以执行以下操作来监视对 Token 程序的调用,并显示每次调用的前 5 行日志:
solana logs | grep "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA invoke" -A 5