Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix links and add script to remove unused files #275

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
.vscode
.idea

node_modules
venv

forta-docs
venv
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/FAQs.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ You can use Forta’s GraphQL API to query the data, or subscribe to notificatio

[Here](https://docs.forta.network/en/latest/api-reference/) you can learn how to use the API.

[Here](https://docs.forta.network/en/latest/subcribing-to-bot/) you can learn how to subscribe to notifications using the Forta App.
[Here](subscribing-to-bot.md) you can learn how to subscribe to notifications using the Forta App.

### **How can I find valuable detection bots in the network?**

Expand Down Expand Up @@ -167,4 +167,4 @@ The community of data scientists and developers in the Forta Network have create

### **Is Forta a blockchain?**

Short answer: no. Forta is not a blockchain in the sense that it does not maintain a shared state between nodes, but it has similar characteristics to a blockchain in that it is a decentralized network of nodes. Forta is more similar to The Graph protocol in that it runs on top of a blockchain. Forta uses a blockchain (i.e. Polygon) to coordinate scan nodes and store IPFS references to alerts generated by bots.
Short answer: no. Forta is not a blockchain in the sense that it does not maintain a shared state between nodes, but it has similar characteristics to a blockchain in that it is a decentralized network of nodes. Forta is more similar to The Graph protocol in that it runs on top of a blockchain. Forta uses a blockchain (i.e. Polygon) to coordinate scan nodes and store IPFS references to alerts generated by bots.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/scam-detector-bot.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The Scam Detector *labels* are each available via Forta's GraphQL API. For acces
### *Labels*
Labels allow a contributor to tag an entity (like an address) with a label. Labels are available via our [GraphQL API](https://docs.forta.network/en/latest/forta-api-reference/#query-labels). This API allows one to search by date range and page over results.

A recent one month sample of the labels can be downloaded [here (prod, V1 label format)](../ScamDetector_0x1d646c4045189991fdfd24a66b192a294158b839a6ec121d740474bdacb3ab23_labels_20230601-20230630.csv) and [here (beta, V2 label format)](../ScamDetector_0x47c45816807d2eac30ba88745bf2778b61bc106bc76411b520a5289495c76db8_labels_20230622-20230630.csv).
A recent one month sample of the labels can be downloaded [here (prod, V1 label format)](ScamDetector_0x1d646c4045189991fdfd24a66b192a294158b839a6ec121d740474bdacb3ab23_labels_20230601-20230630.csv) and [here (beta, V2 label format)](ScamDetector_0x47c45816807d2eac30ba88745bf2778b61bc106bc76411b520a5289495c76db8_labels_20230622-20230630.csv).


**Note:**
Expand Down
2 changes: 1 addition & 1 deletion docs/scan-node/monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ into your browser's search bar.

![View scan node SLA example](../scan-node-view.png)

You can use the [SLA API](sla-api.md) for more details insights.
You can use the [SLA API](../sla-api.md) for more details insights.

Please note that the number in Forta App can differ from what SLA API returns because of time range differences (see Q3 in [FAQ](faq.md)).

Expand Down
4 changes: 2 additions & 2 deletions docs/security-design.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Security - Design

Security starts in the design phase by incorporating strategies to disincentivize and mitigate malicious behaviors. As described in the [Forta Litepaper](../2022-7-11 Forta Litepaper.pdf), the primary guiding principles around the Forta protocol were:
Security starts in the design phase by incorporating strategies to disincentivize and mitigate malicious behaviors. As described in the [Forta Litepaper](2022-7-11_Forta_Litepaper.pdf), the primary guiding principles around the Forta protocol were:

- **Decentralization** - this not only applies to the network of independent scan nodes, but also to the detection bots that the community develops and the governance over the Network. This creates redundancies and increases the reliability of the network in case isolated failures occur.
- **Cryptoeconomic Incentives** - these incentives, like node and bot staking, encourage net positive behavior and disincentivize malicious behaviors.
Expand All @@ -20,4 +20,4 @@ As an example, the [Forta Litepaper](../2022-7-11 Forta Litepaper.pdf) detailed

The architecture of the Forta smart contracts can be seen in the below diagram.

![Forta Network Smart Contract architecture](Forta-Contract-Architecture.jpg)
![Forta Network Smart Contract architecture](Forta-Contract-Architecture.jpg)
12 changes: 6 additions & 6 deletions docs/security-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ Testing of the code must happen through GitHub Actions on each pull request and

Adopting an attacker mindset, the Foundation went beyond employing secure design, development, deployment and testing and enlisted external security experts to assess the Forta Network after it was built. This helped to surface erroneous assumptions and uncover security gaps that may have remained hidden. Forta primarily engaged OpenZeppelin's smart contract auditing expertise as well as Dedalo's web2 and broad threat assessment expertise for other critical components of the Network. All such reports/findings are linked below:

- [Dedalo's Airdrop Assessment, June 17th 2022](../2022Q2-FortaAirdrop-AuditReport.pdf)
- <a href="../Forta Network Airdrop Audit Report.pdf">OpenZeppelin's Airdrop Smart Contract Audit, June 9th 2022</a>
- [Dedalo's Forta Scan Node Assessment, April 7th 2022](../2022Q1-V2-FortaNode-AuditReport.pdf)
- <a href="../OZ Forta Protocol Audit.pdf">OpenZeppelin's Protocol Audit, February 7th 2022</a>
- [Dedalo's Web Security Assessment, January 5th 2022 ](../Forta-Report-DDL-05-01-2022.pdf)
- [Dedalo's Airdrop Assessment, June 17th 2022](2022Q2-FortaAirdrop-AuditReport.pdf)
- [OpenZeppelin's Airdrop Smart Contract Audit, June 9th 2022](Forta_Network_Airdrop_Audit_Report.pdf)
- [Dedalo's Forta Scan Node Assessment, April 7th 2022](2022Q1-V2-FortaNode-AuditReport.pdf)
- [OpenZeppelin's Protocol Audit, February 7th 2022](OZ_Forta_Protocol_Audit.pdf)
- [Dedalo's Web Security Assessment, January 5th 2022 ](Forta-Report-DDL-05-01-2022.pdf)
- [MixBytes' Security Assessment of slash proposal changes, September 2nd 2022](https://github.com/forta-network/forta-contracts/commit/c940dc39b94bc8be6c298deab92a3dd55527f321)
- [Consensys' Security Assessment of Delegated Staking, November 2022](https://consensys.net/diligence/audits/2022/11/forta-delegated-staking/)
- [Consensys' Security Assessment of Delegated Staking, November 2022](https://consensys.net/diligence/audits/2022/11/forta-delegated-staking/)
2 changes: 1 addition & 1 deletion docs/slashing-creating-proposal.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Anyone who detects a slashable offence perpetrated by a Scan Node or Bot may rep

## Requirements.

- Have 1000 FORT bridged to Polygon, per proposal. ** This deposit can be slashed if the proposal does not follow appropriate formatting, it is malicious, false or spam**. Check the [slashing process](./slashing-process.md) for more info.
- Have 1000 FORT bridged to Polygon, per proposal. ** This deposit can be slashed if the proposal does not follow appropriate formatting, it is malicious, false or spam**. Check the [slashing policy](slashing-policy.md) for more info.
- Present verifiable evidence, in the form of screen captures, log files or any file that proves the accusations.
- Have knowledge of uploading files to IPFS.
- Is able to present evidence following Forta's [Evidence Format](#evidence-format)
Expand Down
2 changes: 1 addition & 1 deletion docs/useful-libraries.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Useful libraries

Here is a collection of libraries and APIs that bot developers may find useful when building their bots. Want to add your library here? Check out [this section](/contributing/#improve-the-documentation) to suggest an edit.
Here is a collection of libraries and APIs that bot developers may find useful when building their bots. Want to add your library here? Check out [this section](contributing#improve-the-documentation) to suggest an edit.

## forta-helpers

Expand Down
Loading