Merge pull request #221 from threefoldtech/master-standardize-npm

chore: standardize on npm, remove yarn.lock

Author: sameh-farouk

.github/workflows/CI.yml

@@ -14,9 +14,8 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 20
-          cache: "yarn"
-          cache-dependency-path: "**/yarn.lock"
+          cache: "npm"
       - name: Install dependencies
-        run: yarn install
+        run: npm ci
       - name: Build
-        run: yarn build
+        run: npm run build

LICENSE

@@ -1,6 +1,25 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
+   The software contained in this repository and all rights, title, and interest
+   
+   Copyright © TF TECH NV
+   Belgian Enterprise Number: BE 0712.845.674
+    
+   Authored and maintained by TF TECH NV.
+    
+   TF TECH NV retains ownership of its contributions to this software.
+
+
+   This software is Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
 
    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
@@ -175,27 +194,3 @@
 
    END OF TERMS AND CONDITIONS
 
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright TF TECH NV (Belgium)
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.

README.md

@@ -1,45 +1,73 @@
-# TFChain GraphQL
+# Ledger GraphQL
 
-[Subsquid](https://docs.subsquid.io) is used to index and provide a GraphQL interface on top of TFChain.
+A high-performance indexing layer with a queryable GraphQL API over Ledger Chain on-chain data. It enables efficient data access for dashboards, applications, and analytics tools without directly querying the blockchain.
 
-## Concept
+## What this is
 
-The substrate events are processed in a multi-step pipeline:
+This project provides a [Subsquid](https://docs.subsquid.io)-based indexer that consumes raw blockchain events from Ledger Chain, transforms them into a structured schema, and exposes them through a GraphQL endpoint. It replaces direct chain queries with a fast, developer-friendly API suitable for front-end applications and data analytics.
 
-    TFChain => Squid Indexer => Indexer GraphQL gateway => Squid Processor => Database => Query Node GraphQL endpoint
+## What this repository contains
 
-![Bird eye overview](https://gblobscdn.gitbook.com/assets%2F-MdI-MAyz-csivC8mmdb%2Fsync%2Fe587479ff22ad79886861487b2734b6556302d10.png?alt=media)
+- **Indexer** — Docker Compose setup for the Squid indexer that ingests on-chain events
+- **Processor** — Event processing pipeline that maps raw chain data to database models
+- **GraphQL schema** — `schema.graphql` defining the queryable data model
+- **Database migrations** — Migration files for the processor database
+- **Type definitions** — Chain-specific type files for decoding events
+- **Mapping functions** — Logic for transforming events into indexed entities
+- **Scripts** — Utility scripts for generating initial state and development workflows
+
+## Role in the stack
+
+The indexer sits between the blockchain and consumer applications. It decouples data access from the chain, allowing complex queries, aggregations, and historical lookups that would be inefficient or impossible via direct RPC calls. Dashboards, explorers, and third-party integrations rely on this layer for real-time and historical data.
+
+The data pipeline is:
+
+```
+Ledger Chain => Squid Indexer => Indexer GraphQL gateway => Squid Processor => Database => Query Node GraphQL endpoint
+```
+
+## Relation to ThreeFold
+
+This technology is used within the ThreeFold ecosystem and was first deployed on the ThreeFold Grid. The component itself is designed as reusable infrastructure technology and should be understood by its technical function first, independent of any specific deployment.
+
+## Ownership
+
+This repository is owned and maintained by TF-Tech NV, a Belgian company responsible for the development and maintenance of this technology.
 
 ## Prerequisites
 
-* Node v20+
-* Docker
-* Docker Compose
+- Node v20+
+- Docker
+- Docker Compose
 
 ## Running
 
-See [docs](./docs/readme.md)
+See [docs](./docs/readme.md) for detailed running instructions.
 
 ## Project layout
 
-- `indexer/` - Docker Compose setup for the indexer (archive)
-- `db/` - Processor database migration files
-- `scripts/` - Utility scripts (see [scripts/readme.md](./scripts/readme.md))
-- `src/` - Processor source code
-    - `mappings/` - Event handler functions that map chain events to database entities
-    - `model/` - Generated TypeORM models from `schema.graphql`
-    - `types/` - Auto-generated type definitions (do not edit manually — run `make typegen`)
-    - `processor.ts` - Processor entrypoint: event subscription and dispatch
-- `typegen/` - Type generation infrastructure
-    - `tfchainVersions.jsonl` - Append-only log of runtime metadata from all TFChain networks
-    - `typegen.json` - Typegen config: which events to generate types for
-    - `typesBundle.json` - Frozen pre-V14 type mappings (do not edit for new runtime versions)
-- `docs/` - Documentation
-    - [typeChanges.md](./docs/typeChanges.md) - How to handle type changes on chain (adding new runtime versions, resync guidance)
-    - [development.md](./docs/development.md) - Local development setup
-    - [production.md](./docs/production.md) - Production deployment
-    - [release_process.md](./docs/release_process.md) - Release workflow
-- `schema.graphql` - GraphQL schema — changes here regenerate `src/model/` via `yarn codegen`
-- `Makefile` - Common tasks: `typegen`, `typegen-add`, `typegen-seed`, `version-bump`
-- `processor-chart/` - Helm chart for processor + query node deployment
-- `indexer/chart/` - Helm chart for indexer stack deployment
+- `indexer/` — Docker Compose setup for the indexer (archive)
+- `db/` — Processor database migration files
+- `scripts/` — Utility scripts (see [scripts/readme.md](./scripts/readme.md))
+- `src/` — Processor source code
+    - `mappings/` — Event handler functions that map chain events to database entities
+    - `model/` — Generated TypeORM models from `schema.graphql`
+    - `types/` — Auto-generated type definitions (do not edit manually — run `make typegen`)
+    - `processor.ts` — Processor entrypoint: event subscription and dispatch
+- `typegen/` — Type generation infrastructure
+    - `tfchainVersions.jsonl` — Append-only log of runtime metadata from all Ledger Chain networks
+    - `typegen.json` — Typegen config: which events to generate types for
+    - `typesBundle.json` — Frozen pre-V14 type mappings (do not edit for new runtime versions)
+- `docs/` — Documentation
+    - [typeChanges.md](./docs/typeChanges.md) — How to handle type changes on chain (adding new runtime versions, resync guidance)
+    - [development.md](./docs/development.md) — Local development setup
+    - [production.md](./docs/production.md) — Production deployment
+    - [release_process.md](./docs/release_process.md) — Release workflow
+- `schema.graphql` — GraphQL schema — changes here regenerate `src/model/` via `npm run codegen`
+- `Makefile` — Common tasks: `typegen`, `typegen-add`, `typegen-seed`, `version-bump`
+- `processor-chart/` — Helm chart for processor + query node deployment
+- `indexer/chart/` — Helm chart for indexer stack deployment
+
+## License
+
+This project is licensed under the Apache License 2.0 — see the [LICENSE](LICENSE) file for details.

docker-compose.yml

@@ -32,7 +32,7 @@ services:
       - TYPEORM_LOGGING=error
     ports:
       - 44233:44233
-    command: ["yarn", "process"]
+    command: ["npm", "run", "process"]
 
   query-node:
     image: ghcr.io/threefoldtech/tfchain_graphql_query-node:latest

docs/development.md

@@ -3,8 +3,8 @@
 ## Install
 
 ```bash
-yarn
-yarn build
+npm install
+npm run build
 ```
 
 ## Local Network
@@ -55,9 +55,9 @@ INDEXER_ENDPOINT_URL=http://localhost:8888/graphql
 Start the local PostgreSQL container and run the processor:
 
 ```bash
-yarn build
-yarn db:up
-yarn process
+npm run build
+npm run db:up
+npm run process
 ```
 
 You should see TFChain blocks being processed by the processor:
@@ -79,7 +79,7 @@ At this step, running `docker ps` should show the indexer containers running:
 Start the query node:
 
 ```bash
-yarn api
+npm run api
 ```
 
 Now you can use the GraphQL playground at http://localhost:4000/graphql
@@ -93,7 +93,7 @@ When TFChain has a new spec version with type changes, see [typeChanges.md](./ty
 make typegen-add
 
 # Check what changed in src/types/, add handler branches if needed
-yarn build
+npm run build
 ```
 
 ## Modifying the GraphQL Schema
@@ -103,17 +103,17 @@ If you need to add new entities or fields to the GraphQL API:
 1. Edit `schema.graphql`
 2. Regenerate models and create a migration:
    ```bash
-   yarn codegen
-   yarn build
-   yarn db:create-migration
+   npm run codegen
+   npm run build
+   npm run db:create-migration
    ```
 3. Add or update event handlers in `src/mappings/`
 4. Register new events in `src/processor.ts` if needed
 5. Test locally:
    ```bash
-   yarn db:up
-   yarn db:migrate
-   yarn process
+   npm run db:up
+   npm run db:migrate
+   npm run process
    ```
 
 ## Resetting the Processor Database
@@ -137,7 +137,7 @@ docker compose up -d
 
 ```bash
 ./scripts/reset-db.sh
-yarn process
+npm run process
 ```
 
 ## Debugging