# pinetwork/pirc architecture

> Architecture diagram of the GitHub repository pinetwork/pirc, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/pinetwork/pirc
- Repository: https://github.com/pinetwork/pirc

## Overview

This repository is a documentation-only collection of two Pi specifications, not an implementation. The root README links to the PiRC1 token-design specification and the PiRC2 subscription-contract API specification. File names show each specification’s topic areas, but no document contents or source excerpts were provided, so relationships among those topics are not inferred. The graph therefore captures only the documented entry-point links; it does not represent runtime behavior.

Main entry points: [`ReadMe.md`](https://github.com/pinetwork/pirc/blob/main/ReadMe.md) (Repository README), [`PiRC1/ReadMe.md`](https://github.com/pinetwork/pirc/blob/main/PiRC1/ReadMe.md) (PiRC1 README), [`PiRC2/ReadMe.md`](https://github.com/pinetwork/pirc/blob/main/PiRC2/ReadMe.md) (PiRC2 README)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_index["Repository index"]
  node_root_readme["Repository README<br/>[ReadMe.md]"]
end

subgraph group_token["PiRC1 token design"]
  node_pir1_readme["PiRC1 README<br/>[ReadMe.md]"]
  node_pir1_vision["Vision<br/>[1-vision.md]"]
  node_pir1_core["Core design<br/>[2-core-design.md]"]
  node_pir1_participation["Participation<br/>[3-participation.md]"]
  node_pir1_allocation1["Allocation design 1"]
  node_pir1_allocation2["Allocation design 2"]
  node_pir1_state1["TGE state design 1"]
  node_pir1_state2["TGE state design 2"]
end

subgraph group_subscription["PiRC2 subscription API"]
  node_pir2_readme["PiRC2 README<br/>[ReadMe.md]"]
  node_pir2_intro["Introduction<br/>[1-introduction.md]"]
  node_pir2_overview["Overview<br/>[2-overview.md]"]
  node_pir2_types["Data types<br/>[3-data-types.md]"]
  node_pir2_errors["Error codes<br/>[4-error-codes.md]"]
  node_pir2_constructor["Constructor and services"]
  node_pir2_lifecycle["Subscription lifecycle"]
  node_pir2_queries["Query methods<br/>[7-query-methods.md]"]
  node_pir2_admin["Admin methods<br/>[8-admin-methods.md]"]
  node_pir2_setup["Subscription setup guide"]
end

node_root_readme -->|"links to"| node_pir1_readme
node_root_readme -->|"links to"| node_pir2_readme

click node_root_readme "https://github.com/pinetwork/pirc/blob/main/ReadMe.md"
click node_pir1_readme "https://github.com/pinetwork/pirc/blob/main/PiRC1/ReadMe.md"
click node_pir1_vision "https://github.com/pinetwork/pirc/blob/main/PiRC1/1-vision.md"
click node_pir1_core "https://github.com/pinetwork/pirc/blob/main/PiRC1/2-core-design.md"
click node_pir1_participation "https://github.com/pinetwork/pirc/blob/main/PiRC1/3-participation.md"
click node_pir1_allocation1 "https://github.com/pinetwork/pirc/blob/main/PiRC1/4-allocation/4-allocation%20design%201.md"
click node_pir1_allocation2 "https://github.com/pinetwork/pirc/blob/main/PiRC1/4-allocation/4-allocation%20design%202.md"
click node_pir1_state1 "https://github.com/pinetwork/pirc/blob/main/PiRC1/5-tge-state/5-tge-state%20design%201.md"
click node_pir1_state2 "https://github.com/pinetwork/pirc/blob/main/PiRC1/5-tge-state/5-tge-state%20design%202.md"
click node_pir2_readme "https://github.com/pinetwork/pirc/blob/main/PiRC2/ReadMe.md"
click node_pir2_intro "https://github.com/pinetwork/pirc/blob/main/PiRC2/1-introduction.md"
click node_pir2_overview "https://github.com/pinetwork/pirc/blob/main/PiRC2/2-overview.md"
click node_pir2_types "https://github.com/pinetwork/pirc/blob/main/PiRC2/3-data-types.md"
click node_pir2_errors "https://github.com/pinetwork/pirc/blob/main/PiRC2/4-error-codes.md"
click node_pir2_constructor "https://github.com/pinetwork/pirc/blob/main/PiRC2/5-constructor-and-service-management.md"
click node_pir2_lifecycle "https://github.com/pinetwork/pirc/blob/main/PiRC2/6-subscription-lifecycle.md"
click node_pir2_queries "https://github.com/pinetwork/pirc/blob/main/PiRC2/7-query-methods.md"
click node_pir2_admin "https://github.com/pinetwork/pirc/blob/main/PiRC2/8-admin-methods.md"
click node_pir2_setup "https://github.com/pinetwork/pirc/blob/main/PiRC2/9-subscription-setup-guide.md"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_root_readme toneBlue
class node_pir1_readme,node_pir1_vision,node_pir1_core,node_pir1_participation,node_pir1_allocation1,node_pir1_allocation2,node_pir1_state1,node_pir1_state2 toneAmber
class node_pir2_readme,node_pir2_intro,node_pir2_overview,node_pir2_types,node_pir2_errors,node_pir2_constructor,node_pir2_lifecycle,node_pir2_queries,node_pir2_admin,node_pir2_setup toneMint
```

## Components

### Repository index

- [Repository README](https://github.com/pinetwork/pirc/blob/main/ReadMe.md): `ReadMe.md`

### PiRC1 token design

- [PiRC1 README](https://github.com/pinetwork/pirc/blob/main/PiRC1/ReadMe.md): `PiRC1/ReadMe.md`
- [Vision](https://github.com/pinetwork/pirc/blob/main/PiRC1/1-vision.md): `PiRC1/1-vision.md`
- [Core design](https://github.com/pinetwork/pirc/blob/main/PiRC1/2-core-design.md): `PiRC1/2-core-design.md`
- [Participation](https://github.com/pinetwork/pirc/blob/main/PiRC1/3-participation.md): `PiRC1/3-participation.md`
- [Allocation design 1](https://github.com/pinetwork/pirc/blob/main/PiRC1/4-allocation/4-allocation%20design%201.md): `PiRC1/4-allocation/4-allocation design 1.md`
- [Allocation design 2](https://github.com/pinetwork/pirc/blob/main/PiRC1/4-allocation/4-allocation%20design%202.md): `PiRC1/4-allocation/4-allocation design 2.md`
- [TGE state design 1](https://github.com/pinetwork/pirc/blob/main/PiRC1/5-tge-state/5-tge-state%20design%201.md): `PiRC1/5-tge-state/5-tge-state design 1.md`
- [TGE state design 2](https://github.com/pinetwork/pirc/blob/main/PiRC1/5-tge-state/5-tge-state%20design%202.md): `PiRC1/5-tge-state/5-tge-state design 2.md`

### PiRC2 subscription API

- [PiRC2 README](https://github.com/pinetwork/pirc/blob/main/PiRC2/ReadMe.md): `PiRC2/ReadMe.md`
- [Introduction](https://github.com/pinetwork/pirc/blob/main/PiRC2/1-introduction.md): `PiRC2/1-introduction.md`
- [Overview](https://github.com/pinetwork/pirc/blob/main/PiRC2/2-overview.md): `PiRC2/2-overview.md`
- [Data types](https://github.com/pinetwork/pirc/blob/main/PiRC2/3-data-types.md): `PiRC2/3-data-types.md`
- [Error codes](https://github.com/pinetwork/pirc/blob/main/PiRC2/4-error-codes.md): `PiRC2/4-error-codes.md`
- [Constructor and services](https://github.com/pinetwork/pirc/blob/main/PiRC2/5-constructor-and-service-management.md): `PiRC2/5-constructor-and-service-management.md`
- [Subscription lifecycle](https://github.com/pinetwork/pirc/blob/main/PiRC2/6-subscription-lifecycle.md): `PiRC2/6-subscription-lifecycle.md`
- [Query methods](https://github.com/pinetwork/pirc/blob/main/PiRC2/7-query-methods.md): `PiRC2/7-query-methods.md`
- [Admin methods](https://github.com/pinetwork/pirc/blob/main/PiRC2/8-admin-methods.md): `PiRC2/8-admin-methods.md`
- [Subscription setup guide](https://github.com/pinetwork/pirc/blob/main/PiRC2/9-subscription-setup-guide.md): `PiRC2/9-subscription-setup-guide.md`

## Connections

- Repository README → PiRC1 README: links to
- Repository README → PiRC2 README: links to