1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
use crate::prelude::*;
use sha2::{Digest, Sha256};
use solana_client::nonblocking::rpc_client::RpcClient as NonblockingRpcClient;
use solana_sdk::client::SyncClient;
use solana_sdk::signer::keypair::{keypair_from_seed, read_keypair_file, Keypair};
use solana_sdk::signer::Signer;
use std::env;
use std::result::Result;
use std::str::FromStr;
use std::sync::Arc;
use tokio::sync::RwLock;
use solana_sdk::transaction::Transaction;
use solana_program::message::Message;
use crate::anchor_traits::*;
use solana_program::pubkey::Pubkey;
use anchor_client::anchor_lang::AccountDeserialize;
use borsh::BorshSerialize;
pub fn ix_to_tx(
ixs: &[Instruction],
signers: &[&Keypair],
blockhash: solana_program::hash::Hash,
) -> Result<Transaction, OnDemandError> {
let msg = Message::new(ixs, Some(&signers[0].pubkey()));
let mut tx = Transaction::new_unsigned(msg);
tx.try_sign(&signers.to_vec(), blockhash)
.map_err(|_e| OnDemandError::SolanaSignError)?;
Ok(tx)
}
pub async fn get_enclave_signer_pubkey(
enclave_signer: &Arc<RwLock<Keypair>>,
) -> Result<Arc<Pubkey>, OnDemandError> {
let enclave_signer = enclave_signer.clone();
let ro_enclave_signer = enclave_signer.read().await;
let pubkey = Arc::new(ro_enclave_signer.pubkey());
Ok(pubkey)
}
pub fn load_env_pubkey(key: &str) -> Result<Pubkey, OnDemandError> {
Pubkey::from_str(&env::var(key).unwrap_or_default())
.map_err(|_| OnDemandError::EnvVariableMissing)
}
/// Parse a string into an optional Pubkey. If the string is empty, return None.
pub fn parse_optional_pubkey(var: &str) -> Option<Pubkey> {
if var.is_empty() {
None
} else {
match Pubkey::from_str(var) {
Ok(pubkey) => {
if pubkey != Pubkey::default() {
Some(pubkey)
} else {
None
}
}
Err(_) => None,
}
}
}
/// Generates a keypair from a base seed, secret key, optional additional bytes, and an optional program ID.
///
/// # Arguments
///
/// * `base` - The base seed as a string.
/// * `secret_key` - The secret key as a vector of bytes.
/// * `more_bytes` - Optional additional bytes to include in the seed.
/// * `program_id` - Optional program ID to include in the seed.
///
/// # Returns
///
/// Returns a `Result` containing an `Arc<Keypair>` if the keypair is successfully derived, or an `OnDemandError` if there is an error.
///
/// # Errors
///
/// Returns an `OnDemandError` with the message "InvalidSecretKey" if the length of the secret key is not 32 bytes.
/// Returns an `OnDemandError` with the message "Failed to derive keypair" if there is an error deriving the keypair.
///
/// # Example
///
/// ```rust
/// use solana_sdk::pubkey::Pubkey;
/// use solana_sdk::signature::{Keypair, keypair_from_seed};
/// use solana_sdk::hash::Hash;
/// use sha2::{Digest, Sha256};
/// use std::sync::Arc;
/// use switchboard_solana::OnDemandError;
///
/// let base = "base_seed";
/// let secret_key = vec![0; 32];
/// let more_bytes = Some(vec![1, 2, 3]);
/// let program_id = Some(Pubkey::new_unique());
///
/// let result = switchboard_solana::client::utils::keypair_from_base_seed(base, secret_key, more_bytes, program_id);
/// match result {
/// Ok(keypair) => {
/// // Key pair successfully derived
/// println!("Derived keypair: {:?}", keypair);
/// }
/// Err(error) => {
/// // Error deriving key pair
/// println!("Failed to derive keypair: {:?}", error);
/// }
/// }
/// ```
pub fn keypair_from_base_seed(
base: &str,
secret_key: Vec<u8>,
more_bytes: Option<Vec<u8>>,
program_id: Option<Pubkey>,
) -> Result<Arc<Keypair>, OnDemandError> {
if secret_key.len() != 32 {
return Err(OnDemandError::InvalidSecretKey);
}
let mut seed = base.as_bytes().to_vec();
seed.extend_from_slice(&secret_key);
if let Some(bytes) = more_bytes.as_ref() {
seed.extend_from_slice(bytes);
}
// Optionally, allow the progam ID to be included in the bytes so we
// can create new environments on different program IDs without collisions.
if let Some(program_id) = program_id.as_ref() {
seed.extend_from_slice(&program_id.try_to_vec().unwrap_or_default());
} else {
seed.extend_from_slice(
&*SWITCHBOARD_ON_DEMAND_PROGRAM_ID
.try_to_vec()
.unwrap_or_default(),
);
}
match keypair_from_seed(&Sha256::digest(&seed)) {
Ok(keypair) => Ok(Arc::new(keypair)),
Err(e) => {
if let Some(err) = e.source() {
println!("Failed to derive keypair -- {}", err);
}
Err(OnDemandError::KeyDerivationFailed)
}
}
}
/// Creates a signing keypair generated from randomness sourced from the enclave
/// runtime.
pub fn generate_signer() -> Arc<Keypair> {
let mut randomness = [0; 32];
switchboard_common::Gramine::read_rand(&mut randomness).unwrap();
Arc::new(keypair_from_seed(&randomness).unwrap())
}
pub fn signer_to_pubkey(signer: Arc<Keypair>) -> std::result::Result<Pubkey, OnDemandError> {
Ok(signer.pubkey())
}
pub fn load_keypair_fs(fs_path: &str) -> Result<Arc<Keypair>, OnDemandError> {
match read_keypair_file(fs_path) {
Ok(keypair) => Ok(Arc::new(keypair)),
Err(e) => {
if let Some(err) = e.source() {
println!("Failed to read keypair file -- {}", err);
}
Err(OnDemandError::IoError)
}
}
}
/// Fetches a zero-copy account from the Solana blockchain.
///
/// # Arguments
///
/// * `client` - The Solana RPC client used to interact with the blockchain.
/// * `pubkey` - The public key of the account to fetch.
///
/// # Returns
///
/// Returns a result containing the fetched account data as the specified type `T`, or an `OnDemandError` if an error occurs.
///
/// # Errors
///
/// This function can return the following errors:
///
/// * `OnDemandError::AccountNotFound` - If the account with the specified public key is not found.
/// * `OnDemandError::Message("no discriminator found")` - If no discriminator is found in the account data.
/// * `OnDemandError::Message("Discriminator error, check the account type")` - If the discriminator in the account data does not match the expected discriminator for type `T`.
/// * `OnDemandError::Message("AnchorParseError")` - If an error occurs while parsing the account data into type `T`.
pub fn fetch_zerocopy_account<T: bytemuck::Pod + Discriminator + Owner>(
client: &solana_client::rpc_client::RpcClient,
pubkey: Pubkey,
) -> Result<T, OnDemandError> {
let data = client
.get_account_data(&pubkey)
.map_err(|_| OnDemandError::AccountNotFound)?;
if data.len() < T::discriminator().len() {
return Err(OnDemandError::InvalidDiscriminator);
}
let mut disc_bytes = [0u8; 8];
disc_bytes.copy_from_slice(&data[..8]);
if disc_bytes != T::discriminator() {
return Err(OnDemandError::InvalidDiscriminator);
}
Ok(*bytemuck::try_from_bytes::<T>(&data[8..])
.map_err(|_| OnDemandError::AnchorParseError)?)
}
/// Fetches the account data synchronously from the Solana blockchain using the provided client.
///
/// # Arguments
///
/// * `client` - The client used to interact with the Solana blockchain.
/// * `pubkey` - The public key of the account to fetch.
///
/// # Generic Parameters
///
/// * `C` - The type of the client, which must implement the `SyncClient` trait.
/// * `T` - The type of the account data, which must implement the `bytemuck::Pod`, `Discriminator`, and `Owner` traits.
///
/// # Returns
///
/// Returns a `Result` containing the fetched account data of type `T` if successful, or an `OnDemandError` if an error occurs.
pub fn fetch_zerocopy_account_sync<C: SyncClient, T: bytemuck::Pod + Discriminator + Owner>(
client: &C,
pubkey: Pubkey,
) -> Result<T, OnDemandError> {
let data = client
.get_account_data(&pubkey)
.map_err(|_| OnDemandError::AccountNotFound)?
.ok_or(OnDemandError::AccountNotFound)?;
if data.len() < T::discriminator().len() {
return Err(OnDemandError::InvalidDiscriminator);
}
let mut disc_bytes = [0u8; 8];
disc_bytes.copy_from_slice(&data[..8]);
if disc_bytes != T::discriminator() {
return Err(OnDemandError::InvalidDiscriminator);
}
Ok(*bytemuck::try_from_bytes::<T>(&data[8..])
.map_err(|_| OnDemandError::AnchorParseError)?)
}
/// Fetches an account asynchronously using the provided client and public key.
///
/// # Arguments
///
/// * `client` - The non-blocking RPC client used to fetch the account.
/// * `pubkey` - The public key of the account to fetch.
///
/// # Generic Parameters
///
/// * `T` - The type of the account data. Must implement `bytemuck::Pod`, `Discriminator`, and `Owner`.
///
/// # Returns
///
/// Returns a `Result` containing the fetched account data of type `T` if successful, or an `OnDemandError` if an error occurs.
///
/// # Errors
///
/// This function can return the following errors:
///
/// * `OnDemandError::AccountNotFound` - If the account is not found.
/// * `OnDemandError::Message("no discriminator found")` - If no discriminator is found in the account data.
/// * `OnDemandError::Message("Discriminator error, check the account type")` - If the discriminator does not match the expected value.
/// * `OnDemandError::Message("AnchorParseError")` - If there is an error parsing the account data into type `T`.
///
/// # Example
///
/// ```rust
/// use switchboard_solana::client::NonblockingRpcClient;
/// use switchboard_solana::error::OnDemandError;
/// use switchboard_solana::types::{Discriminator, Owner};
/// use bytemuck::Pod;
/// use solana_sdk::pubkey::Pubkey;
///
/// async fn example(client: &NonblockingRpcClient, pubkey: Pubkey) -> Result<(), OnDemandError> {
/// let account_data: MyAccountType = fetch_zerocopy_account_async(client, pubkey).await?;
/// // Do something with the fetched account data...
/// Ok(())
/// }
/// ```
pub async fn fetch_zerocopy_account_async<T: bytemuck::Pod + Discriminator + Owner>(
client: &NonblockingRpcClient,
pubkey: Pubkey,
) -> Result<T, OnDemandError> {
let data = client
.get_account_data(&pubkey)
.await
.map_err(|_| OnDemandError::AccountNotFound)?;
if data.len() < T::discriminator().len() {
return Err(OnDemandError::InvalidDiscriminator);
}
let mut disc_bytes = [0u8; 8];
disc_bytes.copy_from_slice(&data[..8]);
if disc_bytes != T::discriminator() {
return Err(OnDemandError::InvalidDiscriminator);
}
Ok(*bytemuck::try_from_bytes::<T>(&data[8..])
.map_err(|_| OnDemandError::AnchorParseError)?)
}
pub fn fetch_borsh_account<T: Discriminator + Owner + AccountDeserialize>(
client: &solana_client::rpc_client::RpcClient,
pubkey: Pubkey,
) -> Result<T, OnDemandError> {
let account_data = client
.get_account_data(&pubkey)
.map_err(|_| OnDemandError::AccountNotFound)?;
T::try_deserialize(&mut account_data.as_slice())
.map_err(|_| OnDemandError::AnchorParseError)
}
pub async fn fetch_borsh_account_async<T: Discriminator + Owner + AccountDeserialize>(
client: &NonblockingRpcClient,
pubkey: Pubkey,
) -> Result<T, OnDemandError> {
let account_data = client
.get_account_data(&pubkey)
.await
.map_err(|_| OnDemandError::AccountNotFound)?;
T::try_deserialize(&mut account_data.as_slice())
.map_err(|_| OnDemandError::AnchorParseError)
}
pub fn fetch_borsh_account_sync<C: SyncClient, T: Discriminator + Owner + AccountDeserialize>(
client: &C,
pubkey: Pubkey,
) -> Result<T, OnDemandError> {
let data = client
.get_account_data(&pubkey)
.map_err(|_| OnDemandError::AccountNotFound)?
.ok_or(OnDemandError::AccountNotFound)?;
T::try_deserialize(&mut data.as_slice()).map_err(|_| OnDemandError::AnchorParseError)
}
// type GenericError = Box<dyn std::error::Error + Send + Sync>;