索拉纳程序

使用 Solana 程序 Crates 在 Rust 中编写链上程序。如果编写客户端应用程序，请使用 Solana SDK Crates。

更多关于 Solana 的信息请参阅 Solana 文档。

Solana 程序库 提供了如何使用此 crates 的示例。

还有疑问？在我们的 Stack Exchange 上提问。

lib.rs:

所有索拉纳链上 Rust 程序的基库。

所有在链上运行的索拉纳 Rust 程序都将链接到这个 crates，它作为索拉纳程序的规范库。索拉纳程序还链接到 Rust 标准库，尽管它已针对索拉纳运行环境进行了修改。而与索拉纳网络交互的链外程序通常使用 solana-sdk crates，它导出所有 solana-program-fork-cleon-00 模块。

此库定义

• 用于声明 程序入口点 的宏，
• 核心数据类型,
• 日志 宏，
• 序列化 方法，
• 用于 跨程序指令执行 的方法，
• 系统程序和其他 本地程序 的程序 ID 和指令构造函数，
• sysvar 访问器。

可以在 Solana 程序库 中找到 solana-program-fork-cleon-00 的使用示例。

定义索拉纳程序

与典型的 Rust 程序相比，索拉纳程序 Crates 具有一些独特的属性。

• 它们通常既用于链上使用也用于链下使用。这主要是因为链下客户端可能需要访问由链上程序定义的数据类型。
• 它们不定义main函数，而是使用entrypoint!宏来定义它们的入口点。
• 它们被编译为"cdylib"crate类型，以便由Solana运行时动态加载。
• 它们在受限制的虚拟机环境中运行，虽然它们可以访问Rust标准库，但标准库的许多功能，尤其是与OS服务相关的功能，在运行时将失败、静默不执行或未定义。更多关于Solana文档中Rust标准库的限制，请参阅限制。

由于多个链接在一起的crate不能都定义程序入口点（请参阅entrypoint!文档），一个常见的约定是使用名为no-entrypoint的Cargo功能来允许禁用程序入口点。

Solana程序的骨架通常如下所示

#[cfg(not(feature = "no-entrypoint"))]
pub mod entrypoint {
    use solana_program::{
        account_info::AccountInfo,
        entrypoint,
        entrypoint::ProgramResult,
        pubkey::Pubkey,
    };

    entrypoint!(process_instruction);

    pub fn process_instruction(
        program_id: &Pubkey,
        accounts: &[AccountInfo],
        instruction_data: &[u8],
    ) -> ProgramResult {
        // Decode and dispatch instructions here.
        todo!()
    }
}

// Additional code goes here.

包含以下内容的Cargo.toml文件

[lib]
crate-type = ["cdylib", "rlib"]

[features]
no-entrypoint = []

请注意，Solana程序必须指定其crate类型为"cdylib"，并且"cdylib"crate将由cargo build-bpf命令自动发现和构建。Solana程序通常还具有crate类型"rlib"，以便可以将它们链接到其他Rust crate。

链上与链下编译目标

Solana程序在rbpf虚拟机上运行，该虚拟机实现了eBPF指令集的一种变体。由于这个crate可以编译用于链上和链下执行，而这两个环境显著不同，它广泛使用条件编译来调整其实现以适应环境。用于识别链上程序编译的cfg谓词是target_os = "solana"，如下所示，在链上运行时通过系统调用记录消息，在链下运行时通过库调用

pub fn sol_log(message: &str) {
    #[cfg(target_os = "solana")]
    unsafe {
        sol_log_(message.as_ptr(), message.len() as u64);
    }

    #[cfg(not(target_os = "solana"))]
    program_stubs::sol_log(message);
}

这种cfg模式也适用于需要同时在链上和链下工作的用户代码。

solana-program-fork-cleon-00和solana-sdk以前是单个crate。由于这个历史原因，以及由于solana-program-fork-cleon-00在两个不同环境中的双重使用，它包含一些在编译时对链上程序不可用的功能。它还包含一些在链下场景中运行时会失败的功能。这种区别在文档中反映得并不好。

有关Solana对eBPF的实现及其限制的更完整描述，请参阅Solana主文档中的链上程序。

核心数据类型

• Pubkey — Solana账户的地址。某些账户地址是ed25519公钥，对应的私钥在链下管理。然而，通常账户地址没有对应的私钥，例如程序派生地址，或者私钥对程序操作不相关，甚至可能已被丢弃。由于运行Solana程序不能安全地创建或管理私钥，所以完整的Keypair定义在solana-program-fork-cleon-00之外，而是在solana-sdk中。
• Hash — 加密哈希。用于唯一标识块，也用于通用哈希。
• AccountInfo — 对单个Solana账户的描述。所有可能被程序调用访问的账户都作为AccountInfo提供给程序入口点。
• Instruction — 告诉运行时执行程序的指令，并将一组账户和程序特定数据传递给它。
• ProgramError和ProgramResult — 所有程序必须返回的错误类型，以u64的形式报告给运行时。
• Sol — Solana原生代币类型，该类型提供了与lamports之间的转换，lamports是SOL的最小分数单位，在native_token模块中。

序列化

在Solana运行时、程序和网络中，至少使用了三种不同的序列化格式，并且solana-program-fork-cleon-00为程序提供了所需格式。

在用户编写的Solana程序代码中，序列化主要用于访问AccountInfo数据和Instruction数据，这两者都是程序特定的二进制数据。每个程序都可以自由决定自己的序列化格式，但来自其他来源的数据（例如sysvars）必须使用该数据或数据类型的文档中指示的方法进行反序列化。

在Solana中使用的是三种序列化格式：

• Borsh，由NEAR项目开发的紧凑且规范化的格式，适用于协议定义和归档存储。它有一个Rust实现和一个JavaScript实现，并推荐用于所有目的。

  用户需要自己导入borsh包——它不是由solana-program-fork-cleon-00重新导出的，尽管这个包在其borsh模块中提供了一些有用的工具，这些工具在borsh库中是不可用的。

  函数 Instruction::new_with_borsh 通过使用 borsh 序列化一个值来创建一个 Instruction。

• Bincode 是一个紧凑的序列化格式，实现了 Serde Rust API。由于它没有规范也没有 JavaScript 实现，并且使用 CPU 资源比 borsh 多，因此不建议用于新代码。

  许多系统程序和本地程序指令使用 bincode 进行序列化，并在运行时用于其他目的。在这些情况下，Rust 程序员通常不会直接接触到编码格式，因为它是隐藏在 API 背后的。

  函数 Instruction::new_with_bincode 通过使用 bincode 序列化一个值来创建一个 Instruction。

• Pack 是一个 Solana 特定的序列化 API，被许多旧程序在 Solana 程序库 中用于定义它们的账户格式。它难以实现，并且没有定义一个语言无关的序列化格式。通常不推荐用于新代码。

开发者应仔细考虑序列化的 CPU 成本，并权衡其正确性和易用性：现成的序列化格式往往比精心编写的特定于应用的格式更昂贵；但特定于应用的格式更难确保正确性，并为多语言实现提供支持。程序用手工编写代码打包和解包数据的情况并不少见。

跨程序指令执行

Solana 程序可以使用 invoke 和 invoke_signed 函数调用其他程序，称为 跨程序调用 (CPI)。在调用另一个程序时，调用者必须提供要调用的 Instruction 以及指令所需的每个账户的 AccountInfo。由于程序获取 AccountInfo 值的唯一方式是从运行时在 [程序入口点][entrypoint!] 接收它们，因此调用者程序必须递归地需要被调用程序所需的任何账户，并由 它的 调用者提供。

通过 CPI 转移 lamports 的简单示例

use solana_program::{
    account_info::{next_account_info, AccountInfo},
    entrypoint,
    entrypoint::ProgramResult,
    program::invoke,
    pubkey::Pubkey,
    system_instruction,
    system_program,
};

entrypoint!(process_instruction);

fn process_instruction(
    program_id: &Pubkey,
    accounts: &[AccountInfo],
    instruction_data: &[u8],
) -> ProgramResult {
    let account_info_iter = &mut accounts.iter();

    let payer = next_account_info(account_info_iter)?;
    let recipient = next_account_info(account_info_iter)?;

    assert!(payer.is_writable);
    assert!(payer.is_signer);
    assert!(recipient.is_writable);

    let lamports = 1000000;

    invoke(
        &system_instruction::transfer(payer.key, recipient.key, lamports),
        &[payer.clone(), recipient.clone()],
    )
}

Solana 还包括一个机制，允许程序控制并签署账户，而无需保护相应的秘密密钥，称为 程序派生地址。PDAs 通过 Pubkey::find_program_address 函数派生。使用 PDA，程序可以调用 invoke_signed 来调用另一个程序，同时在虚拟上为 PDA “签署”。

为 PDA 创建账户的简单示例

use solana_program::{
    account_info::{next_account_info, AccountInfo},
    entrypoint,
    entrypoint::ProgramResult,
    program::invoke_signed,
    pubkey::Pubkey,
    system_instruction,
    system_program,
};

entrypoint!(process_instruction);

fn process_instruction(
    program_id: &Pubkey,
    accounts: &[AccountInfo],
    instruction_data: &[u8],
) -> ProgramResult {
    let account_info_iter = &mut accounts.iter();
    let payer = next_account_info(account_info_iter)?;
    let vault_pda = next_account_info(account_info_iter)?;
    let system_program = next_account_info(account_info_iter)?;

    assert!(payer.is_writable);
    assert!(payer.is_signer);
    assert!(vault_pda.is_writable);
    assert_eq!(vault_pda.owner, &system_program::ID);
    assert!(system_program::check_id(system_program.key));

    let vault_bump_seed = instruction_data[0];
    let vault_seeds = &[b"vault", payer.key.as_ref(), &[vault_bump_seed]];
    let expected_vault_pda = Pubkey::create_program_address(vault_seeds, program_id)?;

    assert_eq!(vault_pda.key, &expected_vault_pda);

    let lamports = 10000000;
    let vault_size = 16;

    invoke_signed(
        &system_instruction::create_account(
            &payer.key,
            &vault_pda.key,
            lamports,
            vault_size,
            &program_id,
        ),
        &[
            payer.clone(),
            vault_pda.clone(),
        ],
        &[
            &[
                b"vault",
                payer.key.as_ref(),
                &[vault_bump_seed],
            ],
        ]
    )?;
    Ok(())
}

本地程序

一些 Solana 程序是 本地程序，运行与运行时一起分发的本地机器代码，具有众所周知的程序 ID。

一些本地程序可以被其他程序调用，但有些只能作为由链下客户端包含在Transaction中的“顶级”指令来执行。

这个包定义了大多数本地程序的程序ID。即使有些本地程序不能被其他程序调用，Solana程序可能需要访问它们的程序ID。例如，一个程序可能需要验证ed25519签名验证指令是否包含在其自身指令所在的同一交易中。对于许多本地程序，这个包还定义了表示它们处理的指令的枚举，以及构建指令的构造函数。

以下列表中注明了程序ID和指令构造函数的位置，以及它们是否可以被其他程序调用。

尽管一些本地程序自创世块以来一直活跃，但其他一些在特定的槽位之后动态激活，有些尚未激活。本文档不区分任何特定网络上活跃的本地程序。可以使用solana feature status CLI命令帮助确定活跃的功能。

对Solana程序作者而言，重要的本地程序包括

• 系统程序：创建新账户，分配账户数据，将账户分配给拥有程序，从系统程序拥有的账户中转移lamports并支付交易费用。

  • ID：solana_program::system_program
  • 指令：solana_program::system_instruction
  • 可以被程序调用吗？是

• 计算预算程序：请求为交易请求额外的CPU或内存资源。当从另一个程序调用时，此程序不执行任何操作。

  • ID：solana_sdk::compute_budget
  • 指令：solana_sdk::compute_budget
  • 可以被程序调用吗？否

• ed25519程序：验证ed25519签名。

  • ID：solana_program::ed25519_program
  • 指令：solana_sdk::ed25519_instruction
  • 可以被程序调用吗？否

• secp256k1程序：验证secp256k1公钥恢复操作。

  • ID：solana_program::secp256k1_program
  • 指令：solana_sdk::secp256k1_instruction
  • 可以被程序调用吗？否

• BPF加载器：在链上部署和执行不可变程序。

  • ID：solana_program::bpf_loader
  • 说明：solana_program::loader_instruction
  • 可以被程序调用吗？是

• 可升级BPF加载器：在链上部署、升级和执行可升级程序。

  • ID：solana_program::bpf_loader_upgradeable
  • 说明：solana_program::loader_upgradeable_instruction
  • 可以被程序调用吗？是

• 废弃的BPF加载器：在链上部署和执行不可变程序。

  • ID：solana_program::bpf_loader_deprecated
  • 说明：solana_program::loader_instruction
  • 可以被程序调用吗？是