Skip to content

Commit ab9aa66

Browse files
book: mention consistency between guest max memory and VM memory config (#1531)
closes INT-3561
1 parent 673c67c commit ab9aa66

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

book/src/advanced-usage/sdk.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,10 @@ The `SdkVmConfig` struct allows you to specify the extensions and system configu
3131
{{ #include ../../../crates/sdk/examples/sdk_app.rs:vm_config }}
3232
```
3333

34+
> ℹ️
35+
> When using Rust to write the guest program, the VM system configuration should keep the default value `pointer_max_bits = 29` to match the hardcoded memory limit of the memory allocator. Otherwise, the guest program may fail due to out of bounds memory access in the VM.
36+
37+
3438
## Running a Program
3539

3640
To run your program and see the public value output, you can do the following:

book/src/writing-apps/write-program.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ For debugging purposes, `openvm::io::print` and `openvm::io::println` can be use
2727

2828
> ⚠️ **WARNING**
2929
>
30-
> The maximum memory address for an OpenVM program is `2^29`. Majority of that (approximately 480-500 MB depending on transpilation) is available to the guest program, but large reads may exceed the maximum memory and thus fail.
30+
> The maximum memory address for an OpenVM program is `2^29`. The majority of that (approximately 480-500 MB depending on transpilation) is available to the guest program, but large reads may exceed the maximum memory and thus fail.
3131
3232
## Rust `std` library support
3333

0 commit comments

Comments
 (0)