Skip to content

Commit 5449aae

Browse files
committed
fix: Update navigation and documentation for Historical Fingerprinter challenge
1 parent e95c3b1 commit 5449aae

9 files changed

Lines changed: 82 additions & 9 deletions

File tree

docs/challenges/.nav.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
nav:
22
- README.md
33
- Active Challenges:
4-
- ada_detection: ./ada_detection
4+
- historical_fingerprinter: ./historical_fingerprinter
55
- dev_fingerprinter: ./dev_fingerprinter
66
- Inactive Challenges:
7+
- ada_detection: ./ada_detection
78
- humanize_behaviour: ./humanize_behaviour
89
- ab_sniffer: ./ab_sniffer
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
nav:
22
- README.md
3-
- Anti-Detect Automation Detection v2: v2.md
43
- "*"

docs/challenges/ada_detection/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Each file must be named exactly as shown and contain self-contained JavaScript (
7777

7878
## Challenge Versions
7979

80-
- [**v2** (Active after Feb 14, 2026 14:00 UTC)](./v2.md) - Hardened detection with Fail-Fast scoring
80+
- [**v2** (Active after Feb 14, 2026 14:00 UTC)](depricated/v2.md) - Hardened detection with Fail-Fast scoring
8181
- [**v1** (Deprecated)](./depricated/v1.md)
8282

8383
## Resources & Guides

docs/challenges/ada_detection/depricated/v1.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ title: Anti-Detect Automation Detection
88

99
**ADA Detection v1** focuses on behavioral detection inside NST-Browser where traditional static signals are masked. This version uses a payload-based flow with strict human safety requirements.
1010

11-
For general challenge information, environment details, and plagiarism policies, please refer to the [AAD README](./README.md).
11+
For general challenge information, environment details, and plagiarism policies, please refer to the [AAD README](../README.md).
1212

1313
---
1414

@@ -94,7 +94,7 @@ Any excessive human misclassification would reduce this to **0.0**.
9494

9595
## Submission Guide
9696

97-
To build and submit your solution, please follow the [Building a Submission Commit](../../miner/workflow/3.build-and-publish.md) guide.
97+
To build and submit your solution, please follow the [Building a Submission Commit](../../../miner/workflow/3.build-and-publish.md) guide.
9898

9999
## Submission Templates
100100

docs/challenges/ada_detection/v2.md renamed to docs/challenges/ada_detection/depricated/v2.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ title: Anti-Detect Automation Detection v2
1616

1717
Scoring has transitioned to a **Fail-Fast** model, emphasizing accuracy across three critical pillars: Human Detection, Framework Detection (with a Selenium Safety Gate), and Protocol Accuracy.
1818

19-
For general challenge information, environment details, and plagiarism policies, please refer to the [AAD README](./README.md).
19+
For general challenge information, environment details, and plagiarism policies, please refer to the [AAD README](../README.md).
2020

2121
---
2222

@@ -138,7 +138,7 @@ Any excessive human misclassification, protocol misses, or missing Selenium dete
138138

139139
## Submission Guide
140140

141-
To build and submit your solution, please follow the [Building a Submission Commit](../../miner/workflow/3.build-and-publish.md) guide.
141+
To build and submit your solution, please follow the [Building a Submission Commit](../../../miner/workflow/3.build-and-publish.md) guide.
142142

143143
## Submission Templates
144144

docs/challenges/dev_fingerprinter/v2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ For general information and technical setup, please refer to the [Main README](.
1616

1717
## Mandatory Requirements
1818

19-
1. Use the template provided in the [`templates/commit/src/fingerprinter/`](./templates/commit/src/fingerprinter/fingerprinter.js) directory.
19+
1. Use the template provided in the `templates/commit/src/fingerprinter/` directory.
2020
2. Implement your logic within the `fingerprinter.js` file.
2121
3. Your SDK must:
2222
- Generate a single string (the "fingerprint").
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
nav:
22
- README.md
33
- Historical Fingerprinter v1: v1.md
4+
- "*"
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: Testing Manual
3+
---
4+
5+
# Historical Fingerprinter Testing Manual
6+
7+
This manual provides instructions for testing the Historical Fingerprinter challenge using Docker and Docker Compose.
8+
9+
## Overview
10+
11+
- Tests are designed to evaluate the effectiveness of your detection scripts against the Historical Fingerprinter challenge.
12+
- Uses Docker for easy submission and testing
13+
14+
## Quick Start Guide
15+
16+
### Prerequisites
17+
18+
- Docker
19+
- Docker Compose
20+
21+
### Step 0: Clone the Repository [skip if you cloned already]
22+
23+
```bash
24+
git clone git@github.com:RedTeamSubnet/historical-fingerprinter-challenge.git historical_fingerprinter
25+
cd historical_fingerprinter
26+
```
27+
28+
### Step 1: Provide Your all Scripts
29+
30+
- Paste all of your all 3 scripts into **src/hfp_challenge/challenge/fingerprinter/src/submissions** folder with matching names.
31+
32+
### Step 2: Update Configuration Files
33+
34+
```bash
35+
cp .env.example .env
36+
cp ./templates/compose/compose.override.dev.yml ./compose.override.yml
37+
```
38+
39+
### Step 3: Setting up environmental variables
40+
41+
- Change `HFP_CHALLENGE_API_KEY` with your own preferred API key. You can use any string as API key, but make sure to update it in your detection scripts as well.
42+
43+
### Step 4: Start the Challenge Server
44+
45+
```bash
46+
docker compose up -d challenge-api
47+
```
48+
49+
### Step 4: Test Your Bot
50+
51+
- Visit <https://localhost:10001/docs>
52+
- Authenticate using provided authentication API that you put into the `.env` with `HFP_CHALLENGE_API_KEY` variable.
53+
![alt text](https://github.com/RedTeamSubnet/historical-fingerprinter-challenge/blob/08e3deea03d551a5d97b9f93c41b7b31a5c2ee01/docs/images/image.png?raw=true)
54+
- Test your detection files by running the `/score` endpoint
55+
- if you see the warning log(like `Please visit endpoint <URI> to complete human verification for the task.`) then open given uri in log in your browser to complete human verification in your side.
56+
57+
## Important Notes
58+
59+
- The server runs on port 10001 by default
60+
- Make sure port 10001 is available on your system
61+
- All interactions are logged for analysis. Miners can check logs by running `docker compose logs -f`
62+
- All commands must be executed from challenge's root directory.
63+
- If you want score justification, you can check all results with `results` endpoint after running the `score` endpoint.
64+
65+
## Troubleshooting
66+
67+
If you encounter issues:
68+
69+
1. Check if Docker is running
70+
2. Verify port 10001 is not in use
71+
3. Check Docker logs using `docker compose logs`
72+
4. Ensure you have proper permissions to run Docker commands

0 commit comments

Comments
 (0)