Merge branch 'andrius/repo-cleanup' into 'main'

Repo cleanup

See merge request flarenetwork/ftso/ftso-scaling!169

Author: adg-flare

.env.example

@@ -20,26 +20,23 @@ INDEXER_TOP_TIMEOUT=5
 # Feed Value Provider connection url
 VALUE_PROVIDER_BASE_URL="http://localhost:3101"
 
-# Epoch settings
-ES_FIRST_VOTING_ROUND_START_TS=1704250616
-ES_VOTING_EPOCH_DURATION_SECONDS=20
-ES_FIRST_REWARD_EPOCH_START_VOTING_ROUND_ID=1000
-ES_REWARD_EPOCH_DURATION_IN_VOTING_EPOCHS=5
-INITIAL_REWARD_EPOCH_ID=0
-
-# FTSO specific timings
-FTSO_REVEAL_DEADLINE_SECONDS=10
-
-# Random benching window policy
-RANDOM_GENERATION_BENCHING_WINDOW=50
-
-# Lib config addresses "local-test" | "from-env" | "coston" | "songbird" | "flare";
+# Specify network, determines protocol parameters and contract addresses: "local-test" | "from-env" | "coston" | "songbird" | "flare";
 NETWORK="local-test"
-# Definitions bellow only used when network is set to from-env
+
+# Below parameters only needed  when network is set to from-env
 FTSO_CA_FTSO_SYSTEMS_MANAGER_ADDRESS="0x000000000000000000000000000000000000dEaD"
 FTSO_CA_FTSO_REWARD_OFFERS_MANAGER_ADDRESS="0x000000000000000000000000000000000000dEaD"
 FTSO_CA_REWARD_MANAGER_ADDRESS="0x000000000000000000000000000000000000dEaD"
 FTSO_CA_SUBMISSION_ADDRESS="0x000000000000000000000000000000000000dEaD"
 FTSO_CA_RELAY_ADDRESS="0x000000000000000000000000000000000000dEaD"
 FTSO_CA_FLARE_SYSTEMS_CALCULATOR_ADDRESS="0x000000000000000000000000000000000000dEaD"
 FTSO_CA_VOTER_REGISTRY_ADDRESS="0x000000000000000000000000000000000000dEaD"
+
+ES_FIRST_VOTING_ROUND_START_TS=1704250616
+ES_VOTING_EPOCH_DURATION_SECONDS=20
+ES_FIRST_REWARD_EPOCH_START_VOTING_ROUND_ID=1000
+ES_REWARD_EPOCH_DURATION_IN_VOTING_EPOCHS=5
+INITIAL_REWARD_EPOCH_ID=0
+
+FTSO_REVEAL_DEADLINE_SECONDS=10
+RANDOM_GENERATION_BENCHING_WINDOW=50

.gitlab-ci.yml

@@ -4,22 +4,49 @@ workflow:
       when: never
     - when: always
 
+lint:
+  stage: test
+  image: node:22
+  cache:
+    - key:
+        files:
+          - yarn.lock
+      paths:
+        - node_modules
+        - .yarn-cache
+      policy: pull-push
+  before_script:
+    - yarn install --frozen-lockfile --cache-folder .yarn-cache
+  script:
+    - |
+      set +e  # don't stop on first failure
+      yarn lint:check
+      LINT_EXIT=$?
+      yarn format:check
+      FORMAT_EXIT=$?
+      set -e
+
+      if [ "$LINT_EXIT" -ne 0 ] || [ "$FORMAT_EXIT" -ne 0 ]; then
+        echo "lint:check exit=$LINT_EXIT, format:check exit=$FORMAT_EXIT"
+        exit 1
+      fi
+
 test-all:
   stage: test
   needs: []
   image: node:22
   cache:
-  - key:
-      files:
-      - yarn.lock
-    paths:
-    - node_modules
-    - .yarn-cache
-    policy: pull-push
+    - key:
+        files:
+          - yarn.lock
+      paths:
+        - node_modules
+        - .yarn-cache
+      policy: pull-push
   before_script:
-  - yarn install --frozen-lockfile --cache-folder .yarn-cache
+    - yarn install --frozen-lockfile --cache-folder .yarn-cache
   script:
-  - yarn test:all
+    - yarn test:all
 
 # TODO: enable coverage reports
 # test-coverage:

CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- ...
+
+### Changed
+
+- ...

CODEOWNERS

@@ -0,0 +1 @@
+* @adg-flare @alenabelium

CONTRIBUTING.md

@@ -0,0 +1,90 @@
+# Contributing
+
+This document describes the process of contributing to this project. It is
+intended for anyone considering opening an issue or pull request.
+
+## AI Assistance
+
+Any significant use of the AI assistance in the contribution MUST be disclosed in the pull request along with the extent of the use.
+
+An example disclosure:
+
+> This PR was written primarily by Claude Code.
+
+Or a more detailed disclosure:
+
+> I consulted ChatGPT for the following code snippets: ...
+
+## Quick start
+
+If you'd like to contribute, report a bug, suggest a feature or you've
+implemented a feature you should open an issue or pull request.
+
+Any contribution to the project is expected to contain code that is formatted,
+linted and that the existing tests still pass. Adding unit tests for new code is
+also welcome.
+
+## Dev environment
+
+Prerequisites:
+
+- Node.js, as specified in the `.nvmrc` file. We recommend using `nvm` to manage versions.
+- Yarn 1.22.x
+- Git
+
+Install the dependencies:
+
+```bash
+$ yarn install
+```
+
+### Configuration
+
+Copy `.env.example` to `.env` and fill the required configuration parameters.
+
+
+### Running the FTSO data provider client app
+
+To start the app run:
+
+```bash
+# development
+$ yarn run start
+
+# watch mode
+$ yarn run start:dev
+```
+
+### Testing
+
+To run all tests or check code coverage, use the following commands:
+```bash
+yarn test:all
+yarn test:coverage
+```
+### Linting and formatting
+
+We use ESLint and Prettier:
+- Check lint:
+
+  ```bash
+  yarn lint:check
+  ```
+
+- Auto-fix lint issues:
+
+  ```bash
+  yarn lint:fix
+  ```
+
+- Check formatting:
+
+  ```bash
+  yarn format:check
+  ```
+
+- Auto-format:
+
+  ```bash
+  yarn format:fix
+  ```

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Flare Foundation
+Copyright (c) 2025 Flare Foundation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -1,33 +1,23 @@
+<div align="center">
+  <a href="https://flare.network/" target="blank">
+    <img src="https://content.flare.network/Flare-2.svg" width="300" alt="Flare Logo" />
+  </a>
+  <br/>
+  <a href="CONTRIBUTING.md">Contributing</a>
+  ·
+  <a href="SECURITY.md">Security</a>
+  ·
+  <a href="CHANGELOG.md">Changelog</a>
+</div>
+
 # FTSO Scaling
 
 The repository contains services to support [FTSO Scaling protocol](./protocol/README.md) which include:
 - [Data provider service](./apps/ftso-data-provider/src/README.md)
 - [Reward calculator](./scripts/rewards/README.md)
 - [Reward data analytics scripts](./scripts/analytics/README.md)
 
-The services are [Nest.js](https://nestjs.com/) applications which use logic  that is implemented in [FTSO core library](./libs/ftso-core/)
-
-# Reward calculation results
-
-Reward calculation results are available [here](./rewards-data). See the documentation about [Reward calculator](./scripts/rewards/README.md) for details.
-
-# Installation 
-
-## FTSO data provider
-
-- Install Node.js (ideally 20.11.0 LTS).
-- Install, configure and run the [Flare System C-chain Indexer](https://gitlab.com/flarenetwork/flare-system-c-chain-indexer).
-- Install [Nest.js CLI](https://docs.nestjs.com/first-steps)
-- Clone the repo. 
-- Build the project
-```bash
-yarn build
-```
-- Configure relevant [environment variables](../apps/ftso-reward-calculator/src/config/configuration.ts). 
-- Run the code:
-```bash
-node dist/apps/ftso-data-provider/apps/ftso-data-provider/src/main.js
-```
+The services are [Nest.js](https://nestjs.com/) applications which use logic that is implemented in [FTSO core library](./libs/ftso-core/).
 
 ## FTSO Reward Calculator (experimental)
 

RepoStructure.md

@@ -0,0 +1,25 @@
+# Security policy
+
+## Reporting a vulnerability
+
+Please do not report a vulnerability using an issue or any other public channel.
+
+If you have found a possible vulnerability, please send an email to
+`security at flare dot network`
+or through our Bug Bounty programs.
+
+## Bug bounties
+
+We sincerely appreciate and encourage reports of suspected security vulnerabilities.
+Please refer to our [Immunefi Bug Bounty Program](https://immunefi.com/bug-bounty/flarenetwork/information/) for scope, rules, and submission guidelines.
+
+## Vulnerability disclosures
+
+Critical vulnerabilities will be disclosed via GitHub's
+[security advisory](https://github.com/flare-foundation/ftso-scaling/security) 
+system.
+
+## Audits
+
+Audit reports are published on Flare's [Developer Hub](https://dev.flare.network/support/audits/).
+

SECURITY.md

@@ -11,17 +11,13 @@ type verifiedCallback = (err: Error | null, user?: object, info?: object) => voi
  */
 export class ApiKeyStrategy extends PassportStrategy(HeaderAPIKeyStrategy, "api-key-strategy") {
   constructor(private readonly authService: AuthService) {
-    super(
-      { header: "X-API-KEY", prefix: "" },
-      true,
-      async (apiKey: string, verified: verifiedCallback, req: Request) => {
-        if (this.authService.validateApiKey(apiKey)) {
-          verified(null, {}, {});
-          return req;
-        } else {
-          verified(new UnauthorizedException(), {}, {});
-        }
+    super({ header: "X-API-KEY", prefix: "" }, true, (apiKey: string, verified: verifiedCallback, req: Request) => {
+      if (this.authService.validateApiKey(apiKey)) {
+        verified(null, {}, {});
+        return req;
+      } else {
+        verified(new UnauthorizedException(), {}, {});
       }
-    );
+    });
   }
 }