Class SocialGraph

Constructors

constructor

new SocialGraph(root: string): SocialGraph
Parameters
- root: string
Returns SocialGraph
- Defined in SocialGraph.ts:24

Methods

[iterator]

"[iterator]"(): Generator<string>
Returns Generator<string>
- Defined in SocialGraph.ts:559

addFollower

addFollower(follower: string, followedUser: string): void
Parameters
- follower: string
- followedUser: string
Returns void
- Defined in SocialGraph.ts:322

followedByFriends

followedByFriends(address: string): Set<string>
Parameters
- address: string
Returns Set<string>
- Defined in SocialGraph.ts:412

followedByFriendsCount

followedByFriendsCount(address: string): number
Parameters
- address: string
Returns number
- Defined in SocialGraph.ts:360

followerCount

followerCount(address: string): number
Parameters
- address: string
Returns number
- Defined in SocialGraph.ts:355

getFollowDistance

getFollowDistance(user: string): number
Parameters
- user: string
Returns number
- Defined in SocialGraph.ts:268

getFollowedByUser

getFollowedByUser(user: string, includeSelf?: boolean): Set<string>
Parameters
- user: string
- includeSelf: boolean = false
Returns Set<string>
- Defined in SocialGraph.ts:423

getFollowersByUser

getFollowersByUser(address: string): Set<string>
Parameters
- address: string
Returns Set<string>
- Defined in SocialGraph.ts:435

getFollowListCreatedAt

getFollowListCreatedAt(user: string): undefined | number
Parameters
- user: string
Returns undefined | number
- Defined in SocialGraph.ts:457

getInternalData

getInternalData(): {
    followedByUser: Map<number, Set<number>>;
    followersByUser: Map<number, Set<number>>;
    followListCreatedAt: Map<number, number>;
    ids: UniqueIds;
    mutedByUser: Map<number, Set<number>>;
    muteListCreatedAt: Map<number, number>;
    str: (id: number) => string;
    userMutedBy: Map<number, Set<number>>;
}
Returns {
    followedByUser: Map<number, Set<number>>;
    followersByUser: Map<number, Set<number>>;
    followListCreatedAt: Map<number, number>;
    ids: UniqueIds;
    mutedByUser: Map<number, Set<number>>;
    muteListCreatedAt: Map<number, number>;
    str: (id: number) => string;
    userMutedBy: Map<number, Set<number>>;
}
- Defined in SocialGraph.ts:44

getMutedByUser

getMutedByUser(user: string): Set<string>
Parameters
- user: string
Returns Set<string>
- Defined in SocialGraph.ts:563

getRoot

getRoot(): string
Returns string
- Defined in SocialGraph.ts:39

getUserMutedBy

getUserMutedBy(user: string): Set<string>
Parameters
- user: string
Returns Set<string>
- Defined in SocialGraph.ts:572

getUsersByFollowDistance

getUsersByFollowDistance(distance: number): Set<string>
Parameters
- distance: number
Returns Set<string>
- Defined in SocialGraph.ts:448

handleEvent

handleEvent(
    evs: NostrEvent | NostrEvent[],
    allowUnknownAuthors?: boolean,
    overmuteThreshold?: number,
): void
Parameters
- evs: NostrEvent | NostrEvent[]
- allowUnknownAuthors: boolean = false
- overmuteThreshold: number = 1
Returns void
- Defined in SocialGraph.ts:161

isFollowing

isFollowing(follower: string, followedUser: string): boolean
Parameters
- follower: string
- followedUser: string
Returns boolean
- Defined in SocialGraph.ts:262

merge

merge(other: SocialGraph): Promise<void>
Parameters
- other: SocialGraph
Returns Promise<void>
- Defined in SocialGraph.ts:461

mutedByFriendsCount

mutedByFriendsCount(address: string): number
Parameters
- address: string
Returns number
- Defined in SocialGraph.ts:371

recalculateFollowDistances

recalculateFollowDistances(
    batchSize?: number,
    logEvery?: number,
    logger?: (msg: string) => void,
): Promise<void>
Parameters
- batchSize: number = 1_000
- logEvery: number = 100_000
- logger: (msg: string) => void = console.log
Returns Promise<void>
- Defined in SocialGraph.ts:78

removeFollower

removeFollower(follower: string, followedUser: string): void
Parameters
- follower: string
- followedUser: string
Returns void
- Defined in SocialGraph.ts:326

removeMutedNotFollowedUsers

removeMutedNotFollowedUsers(
batchSize?: number,
logger?: (phase: string, scanned: number, removed: number) => void,
): Promise<number>
Remove users who are muted by someone AND have zero followers. O(E + M) where E = follows edges, M = mutes edges. Now async and non-blocking with batching.
Parameters
- batchSize: number = 10_000
- logger: (phase: string, scanned: number, removed: number) => void = ...
Returns Promise<number>
- Defined in SocialGraph.ts:591

setRoot

setRoot(root: string): Promise<void>
Parameters
- root: string
Returns Promise<void>
- Defined in SocialGraph.ts:57

size

size(): {
    follows: number;
    mutes: number;
    sizeByDistance: { [distance: number]: number };
    users: any;
}
Returns {
    follows: number;
    mutes: number;
    sizeByDistance: { [distance: number]: number };
    users: any;
}
- Defined in SocialGraph.ts:382

stats

stats(
user: string,
): { [distance: number]: { followers: number; muters: number } }
Parameters
- user: string
Returns { [distance: number]: { followers: number; muters: number } }
- Defined in SocialGraph.ts:582

toBinary

toBinary(
    maxNodes?: number,
    maxEdges?: number,
    maxDistance?: number,
    maxEdgesPerNode?: number,
): Promise<Uint8Array<ArrayBufferLike>>
Parameters
- OptionalmaxNodes: number
- OptionalmaxEdges: number
- OptionalmaxDistance: number
- OptionalmaxEdgesPerNode: number
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in SocialGraph.ts:602

toBinaryChunks

toBinaryChunks(
    maxNodes?: number,
    maxEdges?: number,
    maxDistance?: number,
    maxEdgesPerNode?: number,
): AsyncGenerator<Uint8Array<ArrayBufferLike>>
Parameters
- OptionalmaxNodes: number
- OptionalmaxEdges: number
- OptionalmaxDistance: number
- OptionalmaxEdgesPerNode: number
Returns AsyncGenerator<Uint8Array<ArrayBufferLike>>
- Defined in SocialGraph.ts:598

userIterator

userIterator(upToDistance?: number): Generator<string>
Parameters
- OptionalupToDistance: number
Returns Generator<string>
- Defined in SocialGraph.ts:546

`Static`fromBinary

fromBinary(root: string, data: Uint8Array): Promise<SocialGraph>
Parameters
- root: string
- data: Uint8Array
Returns Promise<SocialGraph>
- Defined in SocialGraph.ts:606

`Static`fromBinaryStream

fromBinaryStream(
root: string,
stream: ReadableStream<Uint8Array<ArrayBufferLike>>,
): Promise<SocialGraph>
Parameters
- root: string
- stream: ReadableStream<Uint8Array<ArrayBufferLike>>
Returns Promise<SocialGraph>
- Defined in SocialGraph.ts:610

Class SocialGraph

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SocialGraph

Methods

[iterator]

Returns Generator<string>

addFollower

Parameters

Returns void

followedByFriends

Parameters

Returns Set<string>

followedByFriendsCount

Parameters

Returns number

followerCount

Parameters

Returns number

getFollowDistance

Parameters

Returns number

getFollowedByUser

Parameters

Returns Set<string>

getFollowersByUser

Parameters

Returns Set<string>

getFollowListCreatedAt

Parameters

Returns undefined | number

getInternalData

getMutedByUser

Parameters

Returns Set<string>

getRoot

Returns string

getUserMutedBy

Parameters

Returns Set<string>

getUsersByFollowDistance

Parameters

Returns Set<string>

handleEvent

Parameters

Returns void

isFollowing

Parameters

Returns boolean

merge

Parameters

Returns Promise<void>

mutedByFriendsCount

Parameters

Returns number

recalculateFollowDistances

Parameters

Returns Promise<void>

removeFollower

Parameters

Returns void

removeMutedNotFollowedUsers

Parameters

Returns Promise<number>

setRoot

Parameters

Returns Promise<void>

size

Returns { follows: number; mutes: number; sizeByDistance: { [distance: number]: number }; users: any;}

stats

Parameters

Returns { [distance: number]: { followers: number; muters: number } }

toBinary

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

toBinaryChunks

Returns {
follows: number;
mutes: number;
sizeByDistance: { [distance: number]: number };
users: any;
}

`Static`fromBinary

`Static`fromBinaryStream