ic-auth-client 0.5.0-beta.0

A client library for Internet Computer identity authentication services.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

//! Browser based authentication client configuration and options.

use crate::{
    ArcIdentity, IdleOptions, key::BaseKeyType, storage::async_storage::AuthClientStorage,
};

/// Options for creating a new [`AuthClient`].
#[derive(Default, bon::Builder)]
pub struct AuthClientCreateOptions {
    /// An optional identity to use as the base. If not provided, an `Ed25519` key pair will be used.
    pub identity: Option<ArcIdentity>,
    /// Optional storage with get, set, and remove methods. Currently only `LocalStorage` is supported.
    #[builder(into)]
    pub storage: Option<Box<dyn AuthClientStorage>>,
    /// The type of key to use for the base key. If not provided, `Ed25519` will be used by default.
    pub key_type: Option<BaseKeyType>,
    /// Options for handling idle timeouts. If not provided, default options will be used.
    pub idle_options: Option<IdleOptions>,
}