Skip to content

Commit 0e84cab

Browse files
brbrrCopilot
andauthored
docs: re-version 0.15.0 (#3496)
* docs: re-version 0.15.0 * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Yaroslav Kukharuk <i.kukharuk@gmail.com> --------- Signed-off-by: Yaroslav Kukharuk <i.kukharuk@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 869e6cb commit 0e84cab

9 files changed

Lines changed: 34 additions & 54 deletions

File tree

docs/docs/running-on-kubernetes.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,12 @@ helm repo update
2323
## 2. Install the chart
2424

2525
```bash
26-
helm install my-juno nethermind/juno
26+
# For testing (disables L1 verification, no Ethereum node required)
27+
helm install my-juno nethermind/juno \
28+
--set juno.extraArgs[0]="--disable-l1-verification"
2729
```
2830

29-
This installs the chart with the default configuration (Sepolia network). However, Juno requires either an Ethereum node endpoint or `--disable-l1-verification` to start successfully, which you configure via `juno.extraArgs`. The recommended way is to create a `values.yaml` file:
31+
This installs Juno with the default configuration (Sepolia network) and disables L1 verification so it can start without an Ethereum node. For production use or to enable full L1 verification, configure an Ethereum node endpoint via `juno.extraArgs` in a `values.yaml` file, for example:
3032

3133
```yaml title="values.yaml"
3234
juno:
@@ -258,7 +260,7 @@ helm uninstall my-juno
258260
Uninstalling the chart does **not** delete the PersistentVolumeClaim. To fully remove the data, delete the PVC manually:
259261

260262
```bash
261-
kubectl delete pvc -l app.kubernetes.io/name=juno,app.kubernetes.io/instance=my-juno
263+
kubectl delete pvc -l "app.kubernetes.io/name=juno,app.kubernetes.io/instance=my-juno"
262264
```
263265

264266
:::

docs/versioned_docs/version-0.15.0/_config-options.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
| `db-compression` | `"snappy"` | Database compression profile. Options: snappy, zstd, minlz. Use zstd for low storage. |
1717
| `db-max-handles` | `1024` | A soft limit on the number of open files that can be used by the DB |
1818
| `db-memtable-size` | `256` | Determines the amount of memory (in MBs) allocated for database memtables. |
19+
| `db-memtable-count` | `2` | Determines the number of memtables the database can queue before stalling writes. |
1920
| `db-path` | `path to your db location` | Location of the database files. |
2021
| `disable-l1-verification` | | Disables L1 verification since an Ethereum node is not provided. |
2122
| `disable-rpc-batch-requests` | | Disables handling of batched RPC requests. |
@@ -31,6 +32,7 @@
3132
| `http-port` | `6060` | The port on which the HTTP server will listen for requests. |
3233
| `http-update-host` | `"localhost"` | The interface on which the log level and gateway timeouts HTTP server will listen for requests. |
3334
| `http-update-port` | | The port on which the log level and gateway timeouts HTTP server will listen for requests. |
35+
| `log-json` | | Use JSON encoding for log output. |
3436
| `log-level` | `"info"` | Options: trace, debug, info, warn, error. |
3537
| `max-vm-queue` | `72` | Maximum number for requests to queue after reaching max-vms before starting to reject incoming requests |
3638
| `max-vms` | `36` | Maximum number for VM instances to be used for RPC calls concurrently |

docs/versioned_docs/version-0.15.0/json-rpc.md

Lines changed: 2 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -200,17 +200,15 @@ async fn main() {
200200

201201
Juno supports the following Starknet API versions:
202202

203-
- **v0.10.0**: Accessible via endpoints `/v0_10`, `/rpc/v0_10`
203+
- **v0.10.1**: Accessible via endpoints `/v0_10`, `/rpc/v0_10`
204204
- **v0.9.0**: Accessible via endpoints `/v0_9`, `/rpc/v0_9`
205205
- **v0.8.1**: Accessible via endpoints `/v0_8` or `/rpc/v0_8`, or the default `/`
206-
- **v0.7.0**: Accessible via endpoints `/v0_7`, `/rpc/v0_7`
207-
- **v0.6.0**: Accessible via endpoints `/v0_6`, `/rpc/v0_6`
208206

209207
To use a specific API version, specify the version endpoint in your RPC calls:
210208

211209
<Tabs>
212210

213-
<TabItem value="v10" label="v0.10.0">
211+
<TabItem value="v10" label="v0.10.1">
214212

215213
```bash
216214
curl --location 'http://localhost:6060/v0_10' \
@@ -256,35 +254,5 @@ curl --location 'http://localhost:6060/v0_8' \
256254

257255
</TabItem>
258256

259-
<TabItem value="v7" label="v0.7.0">
260-
261-
```bash
262-
curl --location 'http://localhost:6060/v0_7' \
263-
--header 'Content-Type: application/json' \
264-
--data '{
265-
"jsonrpc": "2.0",
266-
"method": "starknet_chainId",
267-
"params": [],
268-
"id": 1
269-
}'
270-
```
271-
272-
</TabItem>
273-
274-
<TabItem value="v6" label="v0.6.0">
275-
276-
```bash
277-
curl --location 'http://localhost:6060/v0_6' \
278-
--header 'Content-Type: application/json' \
279-
--data '{
280-
"jsonrpc": "2.0",
281-
"method": "starknet_chainId",
282-
"params": [],
283-
"id": 1
284-
}'
285-
```
286-
287-
</TabItem>
288-
289257
</Tabs>
290258

docs/versioned_docs/version-0.15.0/running-juno.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ You can build the Juno binary or Docker image from the source code to access the
9696
### Prerequisites
9797

9898
- [Golang 1.26](https://go.dev/doc/install) or later
99-
- [Rust](https://www.rust-lang.org/tools/install) 1.87.0 or higher.
99+
- [Rust](https://www.rust-lang.org/tools/install) 1.88.0 or higher.
100100
- C compiler: `gcc` or `clang`
101101
- [jemalloc](https://github.com/jemalloc/jemalloc)
102102

docs/versioned_docs/version-0.15.0/staking-validator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Staking on Starknet provides an opportunity to contribute to network security an
1111

1212
## 1. Set up Juno
1313

14-
Juno is a reliable choice for running a Starknet node. Follow the [Running Juno](running-juno) guide to configure Juno using Docker, binaries, source builds, [Kubernetes with Helm](running-on-kubernetes), Google Cloud Platform (GCP).
14+
Juno is a reliable choice for running a Starknet node. Follow the [Running Juno](running-juno) guide to configure Juno using Docker, binaries, source builds, [Kubernetes with Helm](running-on-kubernetes), or Google Cloud Platform (GCP).
1515

1616
## 2. Stake STRK tokens
1717

docs/versioned_docs/version-0.15.0/tuning.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,16 @@ A sensible default is **256 MB** for nodes that satisfy the minimum requirements
3737
Setting this value too high can cause **uneven write performance**. Larger memtables mean flushes happen less frequently but involve more data at once, leading to bursty I/O patterns. If writes accumulate faster than the database can flush, writes will stall entirely until flushing catches up. A moderate value like 256 MB balances flush frequency with I/O smoothness.
3838
:::
3939

40+
## Database Memory Table Count
41+
42+
Set by the `--db-memtable-count` flag (default: 2), this controls the number of memtables the database can hold in memory before stalling writes. Memtables are in-memory buffers where writes accumulate before being flushed to disk.
43+
44+
With the default of 2, Pebble can accept writes into one memtable while flushing a previous one to disk. Increasing this value allows more memtables to be queued, which can absorb write bursts and prevent stalls when flush speed falls behind write speed.
45+
46+
:::warning
47+
Each additional memtable consumes up to `--db-memtable-size` MB of memory. For example, with the default memtable size of 256 MB and a count of 4, up to 1 GB of memory could be used for memtables alone.
48+
:::
49+
4050
## Database Compaction Concurrency
4151

4252
Set by the `--db-compaction-concurrency` flag, this controls how many concurrent compaction workers the database uses. Compaction is the background process that merges and optimises data on disk.

docs/versioned_docs/version-0.15.0/websocket.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -285,15 +285,14 @@ $ websocat -v ws://localhost:6061
285285

286286
Juno supports the following Starknet API versions:
287287

288-
- **v0.10.0**: Accessible via endpoint `/ws/v0_10`
288+
- **v0.10.1**: Accessible via endpoint `/ws/v0_10`
289289
- **v0.9.0**: Accessible via endpoint `/ws/v0_9`
290290
- **v0.8.1**: Accessible via endpoint `/ws/v0_8`
291-
- **v0.7.0**: Accessible via endpoint `/ws/v0_7`
292291

293292
To use a specific API version, specify the version endpoint in your WS calls:
294293

295294
<Tabs>
296-
<TabItem value="v10" label="v0.10.0">
295+
<TabItem value="v10" label="v0.10.1">
297296

298297
```bash
299298
# wscat
@@ -322,16 +321,6 @@ $ wscat -c ws://localhost:6061/ws/v0_8
322321
< {"jsonrpc": "2.0", "result": "v0.15.18", "id": 1}
323322
```
324323

325-
</TabItem>
326-
<TabItem value="v7" label="v0.7.0">
327-
328-
```bash
329-
# wscat
330-
$ wscat -c ws://localhost:6061/ws/v0_7
331-
> {"jsonrpc": "2.0", "method": "juno_version", "id": 1}
332-
< {"jsonrpc": "2.0", "result": "v0.15.18", "id": 1}
333-
```
334-
335324
</TabItem>
336325
</Tabs>
337326

docs/versioned_sidebars/version-0.15.0-sidebars.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"websocket",
2626
{
2727
"type": "html",
28-
"value": "<a href=\"https://playground.open-rpc.org/?uiSchema%5BappBar%5D%5Bui:splitView%5D=false&schemaUrl=https://raw.githubusercontent.com/starkware-libs/starknet-specs/v0.8.0/api/starknet_api_openrpc.json&uiSchema%5BappBar%5D%5Bui:input%5D=false&uiSchema%5BappBar%5D%5Bui:darkMode%5D=true&uiSchema%5BappBar%5D%5Bui:examplesDropdown%5D=false%5C\" target=\"_blank\" rel=\"noopener noreferrer\" class=\"menu__link external-link\">Starknet Node API Endpoints&nbsp;<svg width=\"13.5\" height=\"13.5\" aria-hidden=\"true\" viewBox=\"0 0 24 24\" class=\"iconExternalLink_node_modules-@docusaurus-theme-classic-lib-theme-Icon-ExternalLink-styles-module\"><path fill=\"currentColor\" d=\"M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z\"></path></svg>"
28+
"value": "<a href=\"https://playground.open-rpc.org/?uiSchema%5BappBar%5D%5Bui:splitView%5D=false&schemaUrl=https://raw.githubusercontent.com/starkware-libs/starknet-specs/v0.8.0/api/starknet_api_openrpc.json&uiSchema%5BappBar%5D%5Bui:input%5D=false&uiSchema%5BappBar%5D%5Bui:darkMode%5D=true&uiSchema%5BappBar%5D%5Bui:examplesDropdown%5D=false\" target=\"_blank\" rel=\"noopener noreferrer\" class=\"menu__link external-link\">Starknet Node API Endpoints&nbsp;<svg width=\"13.5\" height=\"13.5\" aria-hidden=\"true\" viewBox=\"0 0 24 24\" class=\"iconExternalLink_node_modules-@docusaurus-theme-classic-lib-theme-Icon-ExternalLink-styles-module\"><path fill=\"currentColor\" d=\"M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z\"></path></svg>"
2929
},
3030
{
3131
"type": "html",

docs/versions.json

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,10 @@
1-
["0.15.0","0.14.0","0.13.0", "0.12.4", "0.11.8", "0.11.0", "0.9.3", "0.8.0"]
1+
[
2+
"0.15.0",
3+
"0.14.0",
4+
"0.13.0",
5+
"0.12.4",
6+
"0.11.8",
7+
"0.11.0",
8+
"0.9.3",
9+
"0.8.0"
10+
]

0 commit comments

Comments
 (0)