const_str_to_pubkey

A Rust library that helps developers derive a constant Pubkey with a constant string. (Base58 decode algorithm is the same with bs58-rs)

We sometimes want to declare a constant Pubkey (e.g., to store the admin's public key). We can use pubkey! macro provided by Solana official library. However, this macro only works with string literals. If we have a constant &'static str (e.g., from the env! macro), we can't derive the constant Pubkey with pubkey! macro.

This crate addresses this issue.

Usage

use const_str_to_pubkey::str_to_pubkey;

const ADMIN_PUBKEY: Pubkey = str_to_pubkey(env!("ADMIN_PUBKEY"));

To compile, run:

ADMIN_PUBKEY=AdminPubkey11111111111111111111111111111111 cargo build-sbf
# or
ADMIN_PUBKEY=AdminPubkey11111111111111111111111111111111 anchor build
# or exports the environment variable

Cargo check error

When running cargo check (sometimes rust-analyzer runs for us), we may get an error, saying the environment variable is not set. This is because cargo doesn't recognize the environment variables we've set.

To solve this issue, we can simply add a cargo configuration file .cargo/config.toml at project/workspace root (for details, refer to The Cargo Book), with content:

[env]
ADMIN_PUBKEY = "AdminPubkey11111111111111111111111111111111"

Note we can use an arbitrary valid public key string here. It doesn't need to be the real admin public key, because this is only to satisfy cargo. When compiling, we still need to specify the environment variable. The compiler won't read environment variables from cargo configuration file. Therefore, it's safe and nice to check in this file with version control system like git.