Solana 代币合约入口程序学习

本文介绍: Solana代币合约源码入口部分代码学习

我们今天学习spl/token/program/src/lib.rs与entrypoint.rs文件，也就是Solana 统一代币合约的入口文件。

我们首先学习lib.rs文件，其代码只有93行，也比较简单，我们来快速学习一下。

内部属性应用于定义它的元素整体，因为它定义在作用的元素内部，所以在内部属性。相应的，定义在元素之外的叫外部属性。关于属性，这里有一篇文章，看完就基本明白了。

我们的lib.rs的前三行代码正好是定义了三个内部属性：

#![allow(clippy::arithmetic_side_effects)]
#![deny(missing_docs)]
#![cfg_attr(not(test), forbid(unsafe_code))]

第一行是允许做什么（允许工具属性），第二行是拒绝什么，第三行是配置属性。具体含义大家可以参考上面那篇文章，我也并没有仔细研究。

pub mod error;
pub mod instruction;
pub mod native_mint;
pub mod processor;
pub mod state;

#[cfg(not(feature = "no-entrypoint"))]
mod entrypoint;

我们知道，公共模块是暴露给外部的，内部模块是隐藏的。但是这里有一个问题，其实整个程序的入口是entrypoint模块中的process_instruction函数，并且该函数也为内部的，那么该入口函数是怎样被调用的？需要后面进一步查看entrypoint!宏的用法。

entrypoint模块（入口模块）定义上方有一个配置属性，是非no-entrypoint特性。为什么这么配置呢？Solana官方文档上讲的很清楚，一个程序是可以作为库被引入到另一个程序中的，如果这两个程序都会有入口，就会起冲突。因此，我们定义了一个叫no-entrypoint的features，只有在非该特性的条件下才会定义entrypoint模块。当我们的程序作为第三方库引入到其它程序中时，其它程序只要在依赖定义里指定features = [ "no-entrypoint" ]就行了。这样两个程序加起来也会只有一个入口，就不会起冲突了。

接下来18-19行是导入了solana_program库及其特定的结构体，注意Rust中的一般原则，结构，枚举等定义直接导入全部路径，而函数一般只导入相应的包，使用时采用包名::函数名的语法，这样就为了方便的区分该函数是外部包定义的还是本包定义的。

pub use solana_program;
use solana_program::{entrypoint::ProgramResult, program_error::ProgramError, pubkey::Pubkey};

注意这里pub use是导入的同时并重新导出整个solana_program包，这样做的原因是方便其它包引入我们的程序时，如果想访问solana_program包中元素，直接使用spl-token::solana_program就行，而不用重新在依赖库里定义solana_program.

五 `declare_id!`宏

这里的 id() 函数应该是上面的declare_id宏产生的，它估计返回一个静态的Pubkey，注意这里比较的中两个引用，在Rust中，比较引用其实是比较指向的值（当然引用类型得相同），比较引用地址是否相同有专门的函数。

显然，Pubkey 实现了 PartialEq特型，否则无法比较是否不相等。实质上，Pubkey的定义是这样子的：

#[wasm_bindgen]
#[repr(transparent)]
#[derive(
    AbiExample,
    BorshDeserialize,
    BorshSchema,
    BorshSerialize,
    Clone,
    Copy,
    Default,
    Deserialize,
    Eq,
    Hash,
    Ord,
    PartialEq,
    PartialOrd,
    Pod,
    Serialize,
    Zeroable,
)]
pub struct Pubkey(pub(crate) [u8; 32]);

我们可以看到，它的内部（底层）其实是一个32元素的u8数组（所以其大小为256位），除了 PartialEq特型，它还实现了很多常用特型，例如Clone和Copy等。因为它的底层是u8数组，所以直接使用derive派生宏来实现部分特型就行。

entrypoint模块代码很少，除了必要的引入外，就只有一个宏调用和程序入口函数定义。我们来看这个函数process_instruction

fn process_instruction(
    program_id: &Pubkey,
    accounts: &[AccountInfo],
    instruction_data: &[u8],
) -> ProgramResult {
    if let Err(error) = Processor::process(program_id, accounts, instruction_data) {
        // catch the error so we can print it
        error.print::<TokenError>();
        return Err(error);
    }
    Ok(())
}

函数内部直接调用了Processor结构体的处理函数进行处理，这里以后再学。

八 `entrypoint！`宏

#[macro_export]
macro_rules! entrypoint {
    ($process_instruction:ident) => {
        /// # Safety
        #[no_mangle]
        pub unsafe extern "C" fn entrypoint(input: *mut u8) -> u64 {
            let (program_id, accounts, instruction_data) =
                unsafe { $crate::entrypoint::deserialize(input) };
            match $process_instruction(&program_id, &accounts, &instruction_data) {
                Ok(()) => $crate::entrypoint::SUCCESS,
                Err(error) => error.into(),
            }
        }
        $crate::custom_heap_default!();
        $crate::custom_panic_default!();
    };
}

这里我们可以看到，它其实定义了一个 pub 函数 entrypoint，用来解析用户输入并将它作为参数传递给我们的process_instruction函数。但是为什么可以调用entrypoint包（非外部包）的这个entrypoint函数，还需要仔细看相关文档，

还有一点是#[macro_export]宏导出，

默认情况下，宏没有基于路径的作用域。但是如果该宏带有 #[macro_export] 属性，则相当于它在当前 crate 的根作用域的顶部被声明。标有 #[macro_export] 的宏始终是 pub 的.

属性no_mangle，用来关闭 Rust 的名称修改（name mangling）功能。Mangling 是编译器在解析名称时，修改我们定义的函数名称，增加一些用于其编译过程的额外信息。

所以为了使 Rust 函数能在其它语言中被调用，必须禁用 Rust 编译器的名称修改功能。通过在1.1的示例代码中增加属性 #[no_mangle] ，告诉 Rust 编译器不要修改此函数的名称。

这个宏定义上也写了，这是全局的，因此只能only once，所以引入其它定义了entrypoint!宏的包时，需要启用 no-entrypoint特性，当然这个特性名称其实是可以自取的。