Struct rings_core::session::SessionSkBuilder

pub struct SessionSkBuilder { /* private fields */ }

SessionSkBuilder is used to build a SessionSk.

Firstly, you need to provide the account’s entity and type to SessionSkBuilder::new method. Then you can call pack_session to get the session dump for signing. After signing, you can call sig to set the signature back to builder. Finally, you can call build to get the SessionSk.

Implementations

impl SessionSkBuilder

pub fn new(account_entity: String, account_type: String) -> SessionSkBuilder

Create a new SessionSkBuilder. The “account_type” is lower case of Account variant. The “account_entity” refers to the entity that is encapsulated by the Account variant, in string format.

pub fn validate_account(&self) -> bool

This is a helper method to let user know if the account params is valid.

pub fn unsigned_proof(&self) -> String

Construct unsigned_info string for signing.

pub fn set_session_sig(self, sig: Vec<u8>) -> Self

Set the signature of session that signed by account.

pub fn set_ttl(self, ttl_ms: u64) -> Self

Set the lifetime of session.

pub fn build(self) -> Result<SessionSk>

Build the SessionSk.