Feat/midnight

.vscode/settings.json

@@ -40,6 +40,7 @@
     "openapi",
     "overusage",
     "podsi",
+    "preprod",
     "redoc",
     "redocly",
     "tbody",

README.md

@@ -42,6 +42,14 @@ Edit the source yaml files and build the package:
 yarn build
 ```
 
+### Midnight GraphQL docs
+
+The Midnight Indexer GraphQL API documentation is generated using [SpectaQL](https://github.com/anvilco/spectaql) from the schema file [`midnight-indexer-api.graphql`](midnight-indexer-api.graphql). The SpectaQL configuration is in [`spectaql.yaml`](spectaql.yaml) and the custom theme is in [`spectaql-theme/`](spectaql-theme/).
+
+To update the GraphQL schema, download the version matching the deployed Midnight Indexer from the [Midnight Indexer repository](https://github.com/midnightntwrk/midnight-indexer/blob/main/indexer-api/graphql/) and replace the local file:
+
+Then rebuild with `yarn bundle` (SpectaQL runs as part of the bundle step) to regenerate the docs in `docs/midnight/`.
+
 Feel free to open PR against the `master` branch. It is a great place to start any discussion for new features and changes to the Blockfrost API.
 
 ### UI

blockfrost-openapi.yaml

@@ -14,7 +14,7 @@ info:
     url: https://opensource.org/licenses/MIT
   termsOfService: https://blockfrost.io/terms
   description: |
-    Blockfrost is an API as a service that allows users to interact with the Cardano blockchain and parts of its ecosystem.
+    Blockfrost is an API as a service that allows users to interact with the Cardano blockchain, Midnight blockchain, and parts of their ecosystems.
 
     ## Tokens
 
@@ -53,6 +53,12 @@ info:
                 <code>https://cardano-preview.blockfrost.io/api/v0</code>
             </td>
         </tr>
+        <tr>
+            <td>Midnight mainnet</td>
+            <td>
+                <code>https://midnight-mainnet.blockfrost.io/api/v0</code>
+            </td>
+        </tr>
         <tr>
             <td>InterPlanetary File System</td>
             <td>
@@ -221,6 +227,23 @@ info:
         </tr>
       </tbody>
     </table>
+
+
+    ## Midnight API
+
+
+    The Midnight Indexer API exposes a GraphQL API that enables clients to query and subscribe to blockchain data — blocks, transactions, contracts, and wallet-related events — indexed from the Midnight blockchain.
+
+    | Service | URL | Protocol |
+    |---------|-----|----------|
+    | **Indexer HTTP API** | `https://midnight-mainnet.blockfrost.io/api/v0` | HTTP POST (GraphQL) |
+    | **Indexer Subscriptions API** | `wss://midnight-mainnet.blockfrost.io/api/v0/ws` | WebSocket |
+    | **Node RPC** | `https://rpc.midnight-mainnet.blockfrost.io` | JSON-RPC |
+
+
+    For the full documentation — queries, mutations, subscriptions, authentication options, and examples — see the Midnight GraphQL API Reference:
+
+    [![Explore the Midnight API →](https://img.shields.io/badge/Explore_the_Midnight_API_→-0033AD?style=for-the-badge)](./midnight/)
 servers:
   - url: https://cardano-mainnet.blockfrost.io/api/v0
     description: Cardano Mainnet network

docs/blockfrost-openapi.yaml

@@ -15,7 +15,7 @@ info:
   termsOfService: 'https://blockfrost.io/terms'
   description: >
     Blockfrost is an API as a service that allows users to interact with the
-    Cardano blockchain and parts of its ecosystem.
+    Cardano blockchain, Midnight blockchain, and parts of their ecosystems.
 
 
     ## Tokens
@@ -63,6 +63,12 @@ info:
                 <code>https://cardano-preview.blockfrost.io/api/v0</code>
             </td>
         </tr>
+        <tr>
+            <td>Midnight mainnet</td>
+            <td>
+                <code>https://midnight-mainnet.blockfrost.io/api/v0</code>
+            </td>
+        </tr>
         <tr>
             <td>InterPlanetary File System</td>
             <td>
@@ -294,6 +300,39 @@ info:
         </tr>
       </tbody>
     </table>
+
+
+
+    ## Midnight API
+
+
+
+    The Midnight Indexer API exposes a GraphQL API that enables clients to query
+    and subscribe to blockchain data — blocks, transactions, contracts, and
+    wallet-related events — indexed from the Midnight blockchain.
+
+
+    | Service | URL | Protocol |
+
+    |---------|-----|----------|
+
+    | **Indexer HTTP API** | `https://midnight-mainnet.blockfrost.io/api/v0` |
+    HTTP POST (GraphQL) |
+
+    | **Indexer Subscriptions API** |
+    `wss://midnight-mainnet.blockfrost.io/api/v0/ws` | WebSocket |
+
+    | **Node RPC** | `https://rpc.midnight-mainnet.blockfrost.io` | JSON-RPC |
+
+
+
+    For the full documentation — queries, mutations, subscriptions,
+    authentication options, and examples — see the Midnight GraphQL API
+    Reference:
+
+
+    [![Explore the Midnight API
+    →](https://img.shields.io/badge/Explore_the_Midnight_API_→-0033AD?style=for-the-badge)](./midnight/)
 servers:
   - url: 'https://cardano-mainnet.blockfrost.io/api/v0'
     description: Cardano Mainnet network