Struct Credential 

pub struct Credential { /* private fields */ }

Lighter API credentials required for authenticated REST, private WebSocket, and L2 transaction signing.

Lighter identifies API keys by numeric index. The API private key signs both auth tokens and L2 transactions for (account_index, api_key_index).

Implementations

impl Credential

pub fn new( api_key_index: u8, api_secret: impl Into<String>, account_index: u64, ) -> Result<Self>

Creates a new Credential instance from a key index, private key, and account index.

Errors

Returns an error if account_index exceeds the signed range used by the Lighter signer or if api_secret is not a 40-byte hex private key.

pub fn resolve( private_key: Option<String>, account_index: Option<u64>, api_key_index: Option<u8>, environment: LighterEnvironment, ) -> Result<Option<Self>>

Resolves credentials from provided config values or environment variables.

Config values take precedence, but a blank or whitespace-only private_key falls back to the environment variable. Environment variables follow credential_env_vars. LIGHTER_API_KEY_INDEX is the per-account API key slot (0..=254), separate from any hex public key the venue reports for that slot.

Errors

Returns an error if any resolved numeric field cannot be parsed, if the account index exceeds the signed range, or if the API private key is not valid 40-byte hex.

pub const fn api_key_index(&self) -> u8

Returns the Lighter API key index.

pub const fn account_index(&self) -> i64

Returns the Lighter account index.

pub fn private_key(&self) -> Result<PrivateKey>

Decodes the API private key for Lighter signing.

Errors

Returns an error if the secret is not 40-byte hex, with or without a 0x prefix.

Trait Implementations

impl Clone for Credential

fn clone(&self) -> Credential

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Credential

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

Formats the value using the given formatter.

impl Drop for Credential

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.