Add a keystore selector (to support Patchwork-style and GoSbot-style paths) #39

2022-05-11T12:19:46Z

glyph commented

2022-05-11 12:19:46 +00:00

We were previously using the GoSbot keystore path by default. This PR introduces a Keystore enum and adds it as an argument to the Sbot::init method.

Here are the relevant code changes:

/// Keystore selector to specify the location of the secret file.
///
/// This enum is used when initiating a connection with an sbot instance.
pub enum Keystore {
    /// Patchwork default keystore path: `.ssb/secret` in the user's home directory.
    Patchwork,
    /// GoSbot default keystore path: `.ssb-go/secret` in the user's home directory.
    GoSbot,
}

pub async fn init(
        keystore: Keystore,
        ip_port: Option<String>,
        net_id: Option<String>,
    ) -> Result<Sbot, GolgiError> {
    
    // ...
    
    let OwnedIdentity { pk, sk, id } = match keystore {
        Keystore::Patchwork => keystore::from_patchwork_local()
            .await
            .expect("couldn't read local secret"),
        Keystore::GoSbot => keystore::from_gosbot_local()
            .await
            .expect("couldn't read local secret"),
    };

And it's invoked like this:

let mut sbot_client = Sbot::init(Keystore::Patchwork, None, None).await?;

CC: @notplants

We were previously using the GoSbot keystore path by default. This PR introduces a `Keystore enum` and adds it as an argument to the `Sbot::init` method. Here are the relevant code changes: ```rust /// Keystore selector to specify the location of the secret file. /// /// This enum is used when initiating a connection with an sbot instance. pub enum Keystore { /// Patchwork default keystore path: `.ssb/secret` in the user's home directory. Patchwork, /// GoSbot default keystore path: `.ssb-go/secret` in the user's home directory. GoSbot, } ``` ```rust pub async fn init( keystore: Keystore, ip_port: Option<String>, net_id: Option<String>, ) -> Result<Sbot, GolgiError> { // ... let OwnedIdentity { pk, sk, id } = match keystore { Keystore::Patchwork => keystore::from_patchwork_local() .await .expect("couldn't read local secret"), Keystore::GoSbot => keystore::from_gosbot_local() .await .expect("couldn't read local secret"), }; ``` And it's invoked like this: ```rust let mut sbot_client = Sbot::init(Keystore::Patchwork, None, None).await?; ``` CC: @notplants

glyph added 2 commits 2022-05-11 12:19:47 +00:00

add keystore selector for initialising sbot d6546733aa

update docs and doc example code to use new keystore selector 9cb8b62843

glyph added the enhancement label 2022-05-11 12:19:53 +00:00

glyph requested review from notplants 2022-05-11 12:19:59 +00:00

notplants commented

2022-05-11 13:41:02 +00:00

looks good!

cool that it takes advantage of the work already in kuska-ssb, nice detective work

looks good! cool that it takes advantage of the work already in kuska-ssb, nice detective work

👍 1

notplants approved these changes 2022-05-11 13:41:53 +00:00