farcaster-rs 1.0.1

A rust crate to interface & interact with the Farcaster.xyz contracts & APIs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

use crate::constants::merkle::API_ROOT;
use crate::types::assets::user_collections::UserCollectionsRoot;
use crate::Farcaster;
use std::error::Error;

impl Farcaster {
    /// Get all collections an FID owns
    /// ```no_run
    /// use farcaster_rs::{Account, Farcaster};
    ///
    /// let account: Account = Account::from_mnemonic("mnemonic phrase", None).await?;
    /// let farcaster: Farcaster = Farcaster::new("eth provider", account).await?;
    ///
    /// // Returns all Farcaster collection owners of the ID specified
    /// let collections = farcaster.get_collections_by_fid(5, None, None).await?;
    /// ```
    pub async fn get_collections_by_fid(
        &self,
        fid: i64,
        limit: Option<i64>,
        cursor: Option<String>,
    ) -> Result<UserCollectionsRoot, Box<dyn Error>> {
        let mut url = format!("{}/v2/user-collections?ownerFid={}", API_ROOT, fid);

        if limit.is_some() {
            url.push_str(format!("&limit={}", limit.unwrap()).as_str())
        }

        if cursor.is_some() {
            url.push_str(format!("&cursor={}", cursor.unwrap()).as_str())
        }

        let collections_reqwest = &self.reqwest_get(&url).await?;

        let collections: UserCollectionsRoot = serde_json::from_str(&collections_reqwest)?;

        Ok(collections)
    }

    /// Get all collections a username owns
    /// ```no_run
    /// use farcaster_rs::{Account, Farcaster};
    ///
    /// let account: Account = Account::from_mnemonic("mnemonic phrase", None).await?;
    /// let farcaster: Farcaster = Farcaster::new("eth provider", account).await?;
    ///
    /// // Returns all Farcaster collection owners of the ID specified
    /// let collections = farcaster.get_collections_by_username("ace", None, None).await?;
    /// ```
    pub async fn get_collections_by_username(
        &self,
        username: &str,
        limit: Option<i64>,
        cursor: Option<String>,
    ) -> Result<UserCollectionsRoot, Box<dyn Error>> {
        let fid = &self.get_user_by_username(username).await?;

        let collection = &self.get_collections_by_fid(fid.fid, limit, cursor).await?;

        Ok(collection.clone())
    }

    /// Get all collections an address owns
    /// ```no_run
    /// use farcaster_rs::{Account, Farcaster};
    ///
    /// let account: Account = Account::from_mnemonic("mnemonic phrase", None).await?;
    /// let farcaster: Farcaster = Farcaster::new("eth provider", account).await?;
    ///
    /// // Returns all Farcaster collection owners of the ID specified
    /// let collections = farcaster.get_collections_by_address("0x000.....", None, None).await?;
    /// ```
    pub async fn get_collections_by_address(
        &self,
        address: &str,
        limit: Option<i64>,
        cursor: Option<String>,
    ) -> Result<UserCollectionsRoot, Box<dyn Error>> {
        let fid = &self.get_user_by_address(address).await?;

        let collection = &self.get_collections_by_fid(fid.fid, limit, cursor).await?;

        Ok(collection.clone())
    }
}