Struct switchboard_common::env::solana::SolanaFunctionEnvironment

pub struct SolanaFunctionEnvironment {

    pub function_key: String,
    pub payer: String,
    pub verifier: String,
    pub reward_receiver: String,
    pub function_data: String,
    pub verifier_enclave_signer: String,
    pub queue_authority: String,
    pub function_routine_key: String,
    pub function_routine_data: String,
    pub function_request_key: String,
    pub function_request_data: String,
    pub cluster: String,
    pub minimum_context_slot: Option<u64>,
}

Available on crate feature client only.

The expected environment variables when a solana function is being executed

Fields

function_key: String

FUNCTION_KEY: the pubkey of the function being executed

payer: String

PAYER: The gas payer for this transaction

verifier: String

VERIFIER: the pubey of the oracle veriying this call

reward_receiver: String

REWARD_RECEIVER: The escrow to send the reward the oracle will receive for executing this function

function_data: String

FUNCTION_DATA: The preloaded data of the FUNCTION_KEY account

verifier_enclave_signer: String

VERIFIER_ENCLAVE_SIGNER: The keypair the verifying oracle is using to sign this transaction.

queue_authority: String

QUEUE_AUTHORITY: The authority of the oracle queue this function is executing on.

function_routine_key: String

FUNCTION_ROUTINE_KEY: If this function is being called with parameters, this variable will hold the pubkey of the request account

function_routine_data: String

FUNCTION_ROUTINE_DATA: The preloaded data of the FUNCTION_ROUTINE_KEY account

function_request_key: String

FUNCTION_REQUEST_KEY: If this function is being called with parameters, this ariable will hold the pubkey of the request account

function_request_data: String

FUNCTION_REQUEST_DATA: The preloaded data of the FUNCTION_REQUEST_KEY account

cluster: String

minimum_context_slot: Option<u64>

Implementations

impl SolanaFunctionEnvironment

pub fn parse() -> Result<Self, SbError>

pub fn to_env(&self) -> Vec<String>

Returns the vec! of environment variable key-value pairs used by bollard

pub fn set_env(&self) -> Result<(), SbError>

Helper method to set all environment variables. Useful to help test your function environment.

Trait Implementations

impl Clone for SolanaFunctionEnvironment

fn clone(&self) -> SolanaFunctionEnvironment

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SolanaFunctionEnvironment

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SolanaFunctionEnvironment

fn default() -> SolanaFunctionEnvironment

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SolanaFunctionEnvironment

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.