feat: add social follow system

[omarsy]

Social Follow System

Overview

The Social Network System is designed to facilitate user interactions within a social network. It allows users to follow and unfollow each other, as well as retrieve information about followers and followed users.

Modules

1. User Management

• This module manages user information within the social follow.
• Each user is represented by a User struct containing their address and lists of followers and followed users.

2. Following Functionality

• Users can follow and unfollow other users.
• When a user follows another user, they are added to the followed user's list of followers, and the followed user is added to the user's list of followed users.
• When a user unfollows another user, they are removed from the followed user's list of followers, and the followed user is removed from the user's list of followed users.

Data Structures

User

type User struct {
	address   std.Address
	followers *avl.Tree // std.Address -> *User
	followeds *avl.Tree // std.Address -> *User
}

Functions

User Management

• Followers() []std.Address: Returns a list of addresses of users who are followers of the user.
• Followed() []std.Address: Returns a list of addresses of users whom the user is following.
• FollowedCount(addr std.Address) uint: Returns the number of users being followed by the user with the given address.
• FollowersCount(addr std.Address) uint: Returns the number of users following the user with the given address.

Following Functionality

• Follow(user *User): Adds the given user to the list of users being followed by the user.
• Unfollow(user *User): Removes the given user from the list of users being followed by the user.

Realm Configuration Process

• Users are managed within the social network system using the provided functionality.
• The system utilizes an AVL tree data structure to efficiently store and retrieve user information.

Usage

• Users interact with the system by following or unfollowing other users.
• User information is maintained and updated dynamically as users follow and unfollow each other.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ No coverage uploaded for pull request base (teritori-unified@26fcec5). Click here to learn what that means.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@                 Coverage Diff                 @@
##             teritori-unified      #15   +/-   ##
===================================================
  Coverage                    ?   29.84%           
===================================================
  Files                       ?      355           
  Lines                       ?    57636           
  Branches                    ?        0           
===================================================
  Hits                        ?    17201           
  Misses                      ?    38891           
  Partials                    ?     1544           

Flag	Coverage Δ
go-1.21.x	62.34% <ø> (?)
misc	62.34% <ø> (?)
misc-_test.genstd	62.34% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[n0izn0iz]

Nice work ❤️

Can you now add pagination to the Followers and Followed queries please?

[n0izn0iz]

please pass the "lint" CI job also

[omarsy]

Nice work ❤️

Can you now add pagination to the Followers and Followed queries please?
Thank you ❤️

pagination added

[n0izn0iz]

LGTM