Skip to content

Commit 5627844

Browse files
slowbackspaceslowbackspace
committed
chore: mention midnight node
1 parent 557638e commit 5627844

8 files changed

Lines changed: 210 additions & 87 deletions

File tree

‎.vscode/settings.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
"openapi",
4141
"overusage",
4242
"podsi",
43+
"preprod",
4344
"redoc",
4445
"redocly",
4546
"tbody",

‎blockfrost-openapi.yaml‎

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -270,13 +270,19 @@ info:
270270
}
271271
```
272272
273-
### Endpoint
273+
### Endpoints
274274
275-
All GraphQL operations (queries, mutations, and subscriptions) use the same endpoint:
276-
* **HTTP:** `https://midnight-{network}.blockfrost.io/api/v0` (POST requests)
277-
* **WebSocket:** `wss://midnight-{network}.blockfrost.io/api/v0/ws` (for subscriptions)
275+
Blockfrost exposes Midnight Indexer API and Midnight Node RPC endpoints:
278276
279-
Currently available network is `preview`. The `mainnet` network is coming soon.
277+
| Service | URL | Protocol |
278+
|---------|-----|----------|
279+
| **Midnight Indexer HTTP API** | `https://midnight-{network}.blockfrost.io/api/v0` | HTTP POST (GraphQL) |
280+
| **Midnight Indexer Subscriptions API** | `wss://midnight-{network}.blockfrost.io/api/v0/ws` | WebSocket |
281+
| **Midnight Node RPC** | `https://midnight-{network}.blockfrost.io/node` | JSON-RPC |
282+
283+
284+
The **Midnight Node RPC** endpoint exposes the Midnight node — use it with libraries like [midnight.js](https://github.com/midnightntwrk/midnight-js) that need a node connection.
285+
Currently available networks are `preview` and `preprod`. The `mainnet` network is coming soon.
280286
281287
### Request Format
282288
@@ -333,9 +339,17 @@ info:
333339
Include your project ID as the `project_id` HTTP header.
334340
335341
Alternatively, you can use **HTTP Basic Auth** directly in the endpoint URL. The username is the network prefix and the password is your project ID:
342+
343+
**Midnight Indexer API:**
336344
```
337345
https://nightpreview:YOUR_PROJECT_ID@midnight-preview.blockfrost.io/api/v0
338-
https://nightmainnet:YOUR_PROJECT_ID@midnight-mainnet.blockfrost.io/api/v0
346+
https://nightpreprod:YOUR_PROJECT_ID@midnight-preprod.blockfrost.io/api/v0
347+
```
348+
349+
**Midnight Node RPC:**
350+
```
351+
https://nightpreview:YOUR_PROJECT_ID@midnight-preview.blockfrost.io/node
352+
https://nightpreprod:YOUR_PROJECT_ID@midnight-preprod.blockfrost.io/node
339353
```
340354
341355
When using WebSocket in the browser (which doesn't support custom headers), include your project ID as a subprotocol by prefixing it with `project_id_`:

‎docs/blockfrost-openapi.yaml‎

Lines changed: 36 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -362,21 +362,33 @@ info:
362362
```
363363
364364
365-
### Endpoint
365+
### Endpoints
366366
367367
368-
All GraphQL operations (queries, mutations, and subscriptions) use the same
369-
endpoint:
368+
Blockfrost exposes Midnight Indexer API and Midnight Node RPC endpoints:
370369
371-
* **HTTP:** `https://midnight-{network}.blockfrost.io/api/v0` (POST
372-
requests)
373370
374-
* **WebSocket:** `wss://midnight-{network}.blockfrost.io/api/v0/ws` (for
375-
subscriptions)
371+
| Service | URL | Protocol |
376372
373+
|---------|-----|----------|
377374
378-
Currently available network is `preview`. The `mainnet` network is coming
379-
soon.
375+
| **Midnight Indexer HTTP API** |
376+
`https://midnight-{network}.blockfrost.io/api/v0` | HTTP POST (GraphQL) |
377+
378+
| **Midnight Indexer Subscriptions API** |
379+
`wss://midnight-{network}.blockfrost.io/api/v0/ws` | WebSocket |
380+
381+
| **Midnight Node RPC** | `https://midnight-{network}.blockfrost.io/node` |
382+
JSON-RPC |
383+
384+
385+
386+
The **Midnight Node RPC** endpoint exposes the Midnight node — use it with
387+
libraries like [midnight.js](https://github.com/midnightntwrk/midnight-js)
388+
that need a node connection.
389+
390+
Currently available networks are `preview` and `preprod`. The `mainnet`
391+
network is coming soon.
380392
381393
382394
### Request Format
@@ -459,11 +471,25 @@ info:
459471
Alternatively, you can use **HTTP Basic Auth** directly in the endpoint URL.
460472
The username is the network prefix and the password is your project ID:
461473
474+
475+
**Midnight Indexer API:**
476+
462477
```
463478
464479
https://nightpreview:YOUR_PROJECT_ID@midnight-preview.blockfrost.io/api/v0
465480
466-
https://nightmainnet:YOUR_PROJECT_ID@midnight-mainnet.blockfrost.io/api/v0
481+
https://nightpreprod:YOUR_PROJECT_ID@midnight-preprod.blockfrost.io/api/v0
482+
483+
```
484+
485+
486+
**Midnight Node RPC:**
487+
488+
```
489+
490+
https://nightpreview:YOUR_PROJECT_ID@midnight-preview.blockfrost.io/node
491+
492+
https://nightpreprod:YOUR_PROJECT_ID@midnight-preprod.blockfrost.io/node
467493
468494
```
469495

‎docs/midnight/index.html‎

Lines changed: 77 additions & 49 deletions
Large diffs are not rendered by default.

‎openapi.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎openapi.yaml‎

Lines changed: 36 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -362,21 +362,33 @@ info:
362362
```
363363
364364
365-
### Endpoint
365+
### Endpoints
366366
367367
368-
All GraphQL operations (queries, mutations, and subscriptions) use the same
369-
endpoint:
368+
Blockfrost exposes Midnight Indexer API and Midnight Node RPC endpoints:
370369
371-
* **HTTP:** `https://midnight-{network}.blockfrost.io/api/v0` (POST
372-
requests)
373370
374-
* **WebSocket:** `wss://midnight-{network}.blockfrost.io/api/v0/ws` (for
375-
subscriptions)
371+
| Service | URL | Protocol |
376372
373+
|---------|-----|----------|
377374
378-
Currently available network is `preview`. The `mainnet` network is coming
379-
soon.
375+
| **Midnight Indexer HTTP API** |
376+
`https://midnight-{network}.blockfrost.io/api/v0` | HTTP POST (GraphQL) |
377+
378+
| **Midnight Indexer Subscriptions API** |
379+
`wss://midnight-{network}.blockfrost.io/api/v0/ws` | WebSocket |
380+
381+
| **Midnight Node RPC** | `https://midnight-{network}.blockfrost.io/node` |
382+
JSON-RPC |
383+
384+
385+
386+
The **Midnight Node RPC** endpoint exposes the Midnight node — use it with
387+
libraries like [midnight.js](https://github.com/midnightntwrk/midnight-js)
388+
that need a node connection.
389+
390+
Currently available networks are `preview` and `preprod`. The `mainnet`
391+
network is coming soon.
380392
381393
382394
### Request Format
@@ -459,11 +471,25 @@ info:
459471
Alternatively, you can use **HTTP Basic Auth** directly in the endpoint URL.
460472
The username is the network prefix and the password is your project ID:
461473
474+
475+
**Midnight Indexer API:**
476+
462477
```
463478
464479
https://nightpreview:YOUR_PROJECT_ID@midnight-preview.blockfrost.io/api/v0
465480
466-
https://nightmainnet:YOUR_PROJECT_ID@midnight-mainnet.blockfrost.io/api/v0
481+
https://nightpreprod:YOUR_PROJECT_ID@midnight-preprod.blockfrost.io/api/v0
482+
483+
```
484+
485+
486+
**Midnight Node RPC:**
487+
488+
```
489+
490+
https://nightpreview:YOUR_PROJECT_ID@midnight-preview.blockfrost.io/node
491+
492+
https://nightpreprod:YOUR_PROJECT_ID@midnight-preprod.blockfrost.io/node
467493
468494
```
469495

‎spectaql.yaml‎

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,20 +43,34 @@ info:
4343
4444
- title: Endpoints
4545
description: |
46-
All GraphQL operations (queries, mutations, and subscriptions) use the same endpoint:
47-
* **HTTP:** `https://midnight-{network}.blockfrost.io/api/v0` (POST requests)
48-
* **WebSocket:** `wss://midnight-{network}.blockfrost.io/api/v0/ws` (for subscriptions)
46+
Blockfrost exposes three Midnight services:
4947
50-
Currently available network is `preview`. The `mainnet` network is coming soon.
48+
| Service | URL | Protocol |
49+
|---------|-----|----------|
50+
| **Midnight Indexer HTTP API** | `https://midnight-{network}.blockfrost.io/api/v0` | HTTP POST (GraphQL) |
51+
| **Midnight Indexer WebSocket API** | `wss://midnight-{network}.blockfrost.io/api/v0/ws` | WebSocket |
52+
| **Node RPC** | `https://midnight-{network}.blockfrost.io/node` | JSON-RPC |
53+
54+
The **Node RPC** endpoint exposes the Midnight node — use it with libraries like [midnight.js](https://github.com/midnightntwrk/midnight-js) that need a node connection.
55+
56+
Currently available networks are `preview` and `preprod`. The `mainnet` network is coming soon.
5157
5258
- title: Authentication
5359
description: |
5460
Include your project ID as the `project_id` HTTP header.
5561
5662
Alternatively, you can use **HTTP Basic Auth** directly in the endpoint URL. The username is the network prefix and the password is your project ID:
63+
64+
**Midnight Indexer API:**
5765
```
5866
https://nightpreview:YOUR_PROJECT_ID@midnight-preview.blockfrost.io/api/v0
59-
https://nightmainnet:YOUR_PROJECT_ID@midnight-mainnet.blockfrost.io/api/v0
67+
https://nightpreprod:YOUR_PROJECT_ID@midnight-preprod.blockfrost.io/api/v0
68+
```
69+
70+
**Midnight Node RPC:**
71+
```
72+
https://nightpreview:YOUR_PROJECT_ID@midnight-preview.blockfrost.io/node
73+
https://nightpreprod:YOUR_PROJECT_ID@midnight-preprod.blockfrost.io/node
6074
```
6175
6276
When using WebSocket in the browser (which doesn't support custom headers), include your project ID as a subprotocol by prefixing it with `project_id_`:

‎src/definitions.yaml‎

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -270,13 +270,19 @@ info:
270270
}
271271
```
272272
273-
### Endpoint
273+
### Endpoints
274274
275-
All GraphQL operations (queries, mutations, and subscriptions) use the same endpoint:
276-
* **HTTP:** `https://midnight-{network}.blockfrost.io/api/v0` (POST requests)
277-
* **WebSocket:** `wss://midnight-{network}.blockfrost.io/api/v0/ws` (for subscriptions)
275+
Blockfrost exposes Midnight Indexer API and Midnight Node RPC endpoints:
278276
279-
Currently available network is `preview`. The `mainnet` network is coming soon.
277+
| Service | URL | Protocol |
278+
|---------|-----|----------|
279+
| **Midnight Indexer HTTP API** | `https://midnight-{network}.blockfrost.io/api/v0` | HTTP POST (GraphQL) |
280+
| **Midnight Indexer Subscriptions API** | `wss://midnight-{network}.blockfrost.io/api/v0/ws` | WebSocket |
281+
| **Midnight Node RPC** | `https://midnight-{network}.blockfrost.io/node` | JSON-RPC |
282+
283+
284+
The **Midnight Node RPC** endpoint exposes the Midnight node — use it with libraries like [midnight.js](https://github.com/midnightntwrk/midnight-js) that need a node connection.
285+
Currently available networks are `preview` and `preprod`. The `mainnet` network is coming soon.
280286
281287
### Request Format
282288
@@ -333,9 +339,17 @@ info:
333339
Include your project ID as the `project_id` HTTP header.
334340
335341
Alternatively, you can use **HTTP Basic Auth** directly in the endpoint URL. The username is the network prefix and the password is your project ID:
342+
343+
**Midnight Indexer API:**
336344
```
337345
https://nightpreview:YOUR_PROJECT_ID@midnight-preview.blockfrost.io/api/v0
338-
https://nightmainnet:YOUR_PROJECT_ID@midnight-mainnet.blockfrost.io/api/v0
346+
https://nightpreprod:YOUR_PROJECT_ID@midnight-preprod.blockfrost.io/api/v0
347+
```
348+
349+
**Midnight Node RPC:**
350+
```
351+
https://nightpreview:YOUR_PROJECT_ID@midnight-preview.blockfrost.io/node
352+
https://nightpreprod:YOUR_PROJECT_ID@midnight-preprod.blockfrost.io/node
339353
```
340354
341355
When using WebSocket in the browser (which doesn't support custom headers), include your project ID as a subprotocol by prefixing it with `project_id_`:

0 commit comments

Comments
 (0)