# Documentation
## Overview
FourYourSafety (FYS) is a comprehensive crypto-Twitter intelligence browser extension designed to track, monitor, and analyze activities on Twitter/X related to cryptocurrency. The extension provides real-time intelligence on deleted tweets, token addresses, follower changes, and profile modifications. Enabling traders and researchers to make better decisions.
## How to Install
* In the github, click on the green button "Code" in the top right of the repo
* Download ZIP
* Extract the folder called "FYS Extension" from the zip file
* Go to [chrome://extensions](chrome://extensions/)
* Enable developer mode in the top right
* Drag the folder you just extracted and drop it in this screen
* Ensure that the slider is turned on and the extension is active
* Alternatively: click on "Load Unpacked" in the top left and select the folder to import it that way
If done correctly, you should see the screen below. You've succesfully installed FYS!
### How to Use
* Visit any X page, let's take [x.com/yeguybsc](https://x.com/yeguybsc) as example
* Click on the newly-appeared FYS icon bubble next to the Follow button
* From here, you can navigate to which data you want to access
* We are now greeted with a plethora of features within this pop up
* If we want to see their CA's, just click on "Contracts" and wait for it to fetch all their (deleted) tweets
* You will see the CA, coin metrics, original tweet and it's contents. Even if deleted
* The same works for the other functions, straightforward and do exactly what they're called
### Deleted Tweets Tracking
* Archives deleted tweets from crypto influencers
* Prevents loss of key information that gets removed
* Real-time monitoring and archival system
### Contract Address (CA) Tracking
* Monitors deleted token addresses and contract changes
* Identifies rug pulls and suspicious activities
* Detects when profiles/projects/influencers remove token promotion tweets
### First Followers Analysis
* Identifies the first followers of new accounts
* Reveals early supporters and potential insider connections
### Profile Changes Monitoring
* Tracks bio and username changes over time
* Detects rebranding attempts and identity shifts
### Key Followers Analysis
* Analyzes follower networks
* Identifies key influencers and connection patterns
### Real-time Alerts (Coming Soon)
{% hint style="info" %}
Instant notifications for suspicious activities, including deleted tweets and profile changes (feature planned).
{% endhint %}
## Technical Architecture
### Extension Stack
* Language: JavaScript (core extension)
* Frontend (website companion): Next.js 14+, TypeScript, TailwindCSS, shadcn/ui
* Utilities: Custom JS modules for Twitter data processing
### Extension Structure (Simplified)
{% code title="project-structure" %}
```plaintext
/extension
/scripts
- apiService (code that handles the data processing)
- background.js
- content.js
- popup.js
/utils
- apiClient.js
- tweetUtils.js
/assets
- icons/
- css/
manifest.json
```
{% endcode %}
## API Integration
### Key Endpoints
* `getFirstFollowers(user, how, page)` → First followers of an account
* `getBioHistory(user, how, page)` → Historical bio changes
* `getPastUsernames(user, how, page)` → Username history
* `getDeletedTweets(user, how, page)` → Deleted tweets
* `getLatestTweets(user, how, page)` → Most recent tweets
* `getScoredFollowers(user, how, page)` → Follower quality & influence
### Features
* API key authentication
* JSON request/response handling
* Credit system filtering
* Error handling & retry logic
### Tweet Processing Utilities
* `filterTweetsWithAddresses(tweets)` → Extract BSC-related addresses
* `combineTweets(deleted, latest)` → Merge & deduplicate lists
* `processTweets(deletedResult, latestResult)` → End-to-end pipeline
## Design Principles
* Utility-first design for readability and speed
* Minimal UI overlay on Twitter/X
* Privacy-conscious: data stored locally unless explicitly queried
* Performance-oriented: fast background scripts, non-intrusive DOM interaction
## Extension Features
* Real-time monitoring of Twitter data
* Lightweight popup dashboard for quick access
* Background scripts handle data fetching and storage
* Configurable options for alerts & filters
## Token Utility ($FYS)
* Access Pass: Free access for token holders
* No Subscriptions: Token replaces monthly fees
* Governance: DAO decides thresholds and feature access
* Benefits:
* Early access to new features
* Voting rights on roadmap
* Exclusive channels & premium tools
## Use Cases
### Traders
* Detect pump & dump "rugpull" schemes
* Monitor deleted token promotions
* Track influencer sentiment changes
* Find alpha
### Researchers
* Archive deleted crypto content
* Study influence networks and insider behavior
* Analyze narrative evolution across Twitter/X
##
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.fouryoursafety.fun/documentation.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
