Functions — github.com/TheLDB/farcaster-rs

hub / github.com/TheLDB/farcaster-rs / functions

Functions65 in github.com/TheLDB/farcaster-rs

⨍ Functions 65 ◇ Types & classes 94

↓ 13 callersMethodreqwest_get

bridge to reqwest get call

src/api/mod.rs:8

↓ 8 callersMethodget_user_by_address

Get information about a user via their Ethereum address

src/users/get_user.rs:38

↓ 7 callersMethodget_user_by_username

Get information about a user via their Farcaster Username

src/users/get_user.rs:26

↓ 3 callersMethodgenerate_bearer

generate Merkle v2 API bearer token

src/account/mod.rs:131

↓ 2 callersMethodfollow_user_by_fid

Get a users followers via their FID # Params fid: i64 # Example ```no_run let follow = farcaster.follow_user_by_fid(0).await?; ```

src/follows/follow_user.rs:17

↓ 2 callersMethodget_address_by_fid

get address assigned to `fid` returns None if not found

src/registry/mod.rs:71

↓ 2 callersMethodget_casts_by_fid

Get a users casts by their FID ## Params fid: i64 limit: Option<i32> cursor: Option<&str> ## Example ```no_run let casts = farcaster.get_casts_by_fi

src/casts/get_casts.rs:19

↓ 2 callersMethodget_collections_by_fid

Get all collections an FID owns ```no_run use farcaster_rs::{Account, Farcaster}; let account: Account = Account::from_mnemonic("mnemonic phrase", No

src/assets/get_user_collections.rs:17

↓ 2 callersMethodget_fid_by_address

get fid assigned to `address` return None if not found

src/registry/mod.rs:39

↓ 2 callersMethodget_followers_by_fid

( &self, fid: i64, limit: Option<i32>, cursor: Option<&str>, )

src/follows/get_followers.rs:7

↓ 2 callersMethodget_following_by_fid

( &self, fid: i64, limit: Option<i64>, cursor: Option<&str>, )

src/follows/following.rs:7

↓ 2 callersMethodget_session_token

get Merkle v2 API session token

src/account/mod.rs:139

↓ 2 callersMethodget_user_by_fid

Get information about a user via their Farcaster ID (more commonly shortened to FID throughout this codebase

src/users/get_user.rs:8

↓ 2 callersMethodget_verifications_by_fid

Get verifications of a user by their FID

src/verifications/get_verifications.rs:8

↓ 2 callersMethodunfollow_user_by_fid

(&self, fid: i64)

src/follows/unfollow_user.rs:8

↓ 1 callersMethodget_address_by_username

get address assigned to `username` returns None if not found

src/registry/mod.rs:61

↓ 1 callersMethodget_auth_token

Get your authentication token

src/account/mod.rs:115

↓ 1 callersMethodget_fid_by_username

get fid assigned to `username` return None if not found

src/registry/mod.rs:51

↓ 1 callersMethodget_fir_register_logs

[private] get Farcaster ID Registry Register logs starting at block `from_block`

src/registry/mod.rs:192

↓ 1 callersMethodget_fnr_transfer_logs

[private] get Farcaster Name Registry Transfer logs starting at block `from_block`

src/registry/mod.rs:231

↓ 1 callersMethodget_username_by_address

get username assigned to `address` returns None if not found

src/registry/mod.rs:91

↓ 1 callersMethodsync

sync Farcaster ID/Name Registry

src/registry/mod.rs:102

↓ 1 callersMethodsync_fir_logs

[private] sync Farcaster ID Registry logs TODO: parse "Transfer" logs

src/registry/mod.rs:114

↓ 1 callersMethodsync_fnr_logs

[private] sync Farcaster Name Registry logs

src/registry/mod.rs:161

↓ 1 callersFunctiontoken_to_fname

# Convert a FC V2 token to an fname (username) ## Arguments `token: Token` - Token is a type of ethers::abi::Token - Retrieveable by parsing a log f

src/registry/token_to_fname.rs:15

Methoddelete_cast_by_cast_hash

Delete a cast via its hash ## Params cast_hash: &str ## Example ```no_run let casts = farcaster.delete_cast_by_cast_hash("cast_hash").await?; ```

src/casts/delete_cast.rs:17

Methoddelete_like_by_cast_hash

Unlike a cast # Params cast_hash: &str # Example ```no_run farcaster.delete_like_by_cast_hash("cast hash").await?; ```

src/reactions/delete_like.rs:17

Methoddelete_recast_by_cast_hash

Delete a recast by the parent cast's hash # Params cast_hash: &str # Example ```no_run let delete = farcaster.delete_recast_by_cast_hash("cast hash"

src/reactions/delete_recast.rs:17

Methodfollow_user_by_address

Get a users followers via their address # Params address: &str # Example ```no_run let follow = farcaster.follow_user_by_address("0x000....").await?

src/follows/follow_user.rs:67

Methodfollow_user_by_username

Get a users followers via their username # Params username: &str # Example ```no_run let follow = farcaster.follow_user_by_username("abc").await?; `

src/follows/follow_user.rs:47

Methodfrom_mnemonic

Initialize an account with a mnemonic phrase # Params mnemonic_phrase: &str, token_duration: Option<i64> - Defaults to 1hr # Example ```no_run let a

src/account/mod.rs:51

Methodfrom_private_key

Initialize an account with a private key # Params: key: &str, token_duration: Option<i64> - Defaults to 1hr # Example ```no_run let account = farcas

src/account/mod.rs:88

Methodgenerate_bearer

# Best not to use this function directly Instead, use the [Account struct](../types/account/struct.Account.html) methods, such as from_mnemonic, and f

src/account/auth/generate_bearer.rs:20

Methodget_api_health

()

src/misc/api_health.rs:6

Methodget_casts_by_address

Get a users casts by their Address ## Params address: &str limit: Option<i32> cursor: Option<&str> ## Example ```no_run let casts = farcaster.get_ca

src/casts/get_casts.rs:78

Methodget_casts_by_username

Get a users casts by their Username ## Params username: &str limit: Option<i32> cursor: Option<&str> ## Example ```no_run let casts = farcaster.get_

src/casts/get_casts.rs:54

Methodget_collection_owners

( &self, collection_id: &str, limit: Option<i64>, cursor: Option<String>,

src/assets/get_collection_owners.rs:7

Methodget_collections_by_address

Get all collections an address owns ```no_run use farcaster_rs::{Account, Farcaster}; let account: Account = Account::from_mnemonic("mnemonic phrase"

src/assets/get_user_collections.rs:73

Methodget_collections_by_username

Get all collections a username owns ```no_run use farcaster_rs::{Account, Farcaster}; let account: Account = Account::from_mnemonic("mnemonic phrase"

src/assets/get_user_collections.rs:50

Methodget_custody_address_by_address

Get a custody address by FID

src/users/get_custody_address.rs:36

Methodget_custody_address_by_fid

Get a custody address by FID

src/users/get_custody_address.rs:8

Methodget_custody_address_by_username

Get a custody address by FID

src/users/get_custody_address.rs:22

Methodget_fir_transfer_logs

(&mut self, from_block: u64)

src/registry/mod.rs:212

Methodget_followers_by_address

( &self, address: &str, limit: Option<i32>, cursor: Option<&str>, )

src/follows/get_followers.rs:43

Methodget_followers_by_username

( &self, username: &str, limit: Option<i32>, cursor: Option<&str>, )

src/follows/get_followers.rs:30

Methodget_following_by_address

( &self, address: &str, limit: Option<i64>, cursor: Option<&str>, )

src/follows/following.rs:43

Methodget_following_by_username

( &self, username: &str, limit: Option<i64>, cursor: Option<&str>, )

src/follows/following.rs:30

Methodget_likes_by_cast_hash

Get likes by the cast hash # Params cast_hash: &str limit: Option<i32> - Optional # of likes to get (max 100) cursor: Option<&str> - Optional cursor

src/reactions/get_likes.rs:18

Methodget_me

Get information about the authenticated user

src/users/me.rs:8

Methodget_notifications

Fetch your notifications # Params limit: Option<i64> - How many casts to get (max 100) cursor: Option<&str) - For pagination # Example ```no_run let

src/notifications/get_notifications.rs:17

Methodget_recasters_by_cast_hash

Get recasters by cast hash # Params cast_hash: &str, limit: Option<i32> - Optional # of recasters to get (max 100) cursor: Option<&str) - Optional cu

src/reactions/get_recasters.rs:18

Methodget_session_token

# Best not to use this function directly Instead, use the [Account struct](../types/account/struct.Account.html) methods, such as from_mnemonic, and f

src/account/auth/get_session_token.rs:15

Methodget_username_by_fid

get username assigned to `fid` returns None if not found

src/registry/mod.rs:81

Methodget_verifications_by_address

Get verifications of a user by their address

src/verifications/get_verifications.rs:34

Methodget_verifications_by_username

Get verifications of a user by their username

src/verifications/get_verifications.rs:22

Methodlike_cast_by_cast_hash

Like cast by the cast hash # Params cast_hash: &str # Example ```no_run farcaster.like_cast_by_cast_hash("cast hash").await?; ```

src/reactions/like_cast.rs:17

Methodnew

(ethereum_provider: &str, account: Account)

src/lib.rs:115

Methodnew

create new Registry provider: Ethereum HTTP provider

src/registry/mod.rs:18

Methodpublish_cast

Publish a cast to the protocol ```no_run use farcaster_rs::{Account, Farcaster}; let account: Account = Account::from_mnemonic("mnemonic phrase", Non

src/casts/publish_cast.rs:21

Methodrecast_by_cast_hash

Recast a cast by its hash # Params cast_hash: &str # Example ```no_run let recast = farcaster.recast_by_cast_hash("cast hash").await?; ```

src/reactions/recast.rs:17

Methodregen_session_token

Function to regenete your session token. Ideal for bots. Regenerate every hour to secure your token.

src/account/mod.rs:153

Methodrevoke_auth_token

Revokes a specific session token

src/account/mod.rs:172

Methodrevoke_session_token

Best not to use this function on its own, as the Account struct has a method that does this in a clean way i.e. ``farcaster.account.revoke_auth_token(

src/account/auth/revoke_session_token.rs:11

Methodunfollow_user_by_address

( &self, address: &str, )

src/follows/unfollow_user.rs:40

Methodunfollow_user_by_username

( &self, username: &str, )

src/follows/unfollow_user.rs:29