Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Snapshot documentation update #1161

Merged
merged 8 commits into from
Sep 7, 2023
Merged

Snapshot documentation update #1161

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5dbffef
State manager documentation updated
Juliusan Aug 30, 2023
be8d8d6
Duplicated recent changes to other profile
Juliusan Aug 30, 2023
adf935d
Apply suggestions from code review
Dr-Electron Aug 30, 2023
49290cd
Format
Dr-Electron Aug 30, 2023
a9a9d2a
Merge branch 'main' into feat/state-manager-snapshots
Juliusan Sep 5, 2023
b8c6e62
Documentation update after recent snapshot functionality update
Juliusan Sep 5, 2023
f4a0a11
Update docs/learn/smart-contracts/core_concepts/state_manager.md
Juliusan Sep 6, 2023
da8ac13
Update docs/learn/smart-contracts/core_concepts/state_manager.md
Juliusan Sep 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/learn/smart-contracts/core_concepts/state_manager.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The snapshot format is as follows:
The node that makes a snapshot can serve it over http and new nodes can use this to speed up the catch up. Serving the snapshots
over http is beyond the scope of Wasp and should be done in addition. Wasp is only responsible for making snapshots in local
(configurable by `snapshots.localPath` parameter) folder and obtaining them on start when needed from the same local folder or from
configured (by `snapshots.networkPaths` parameter) http addresses. A folder, serving snapshot files over http must contain
configured (by `snapshots.networkPaths` parameter) URLs. A folder, referenced in the `snapshots.networkPaths` parameter must contain
`INDEX` file with new line separated list of snapshot file names.

If a chain starts with an empty database (usually if the database hasn't been created yet or was deleted), the node checks if
Expand Down Expand Up @@ -196,7 +196,9 @@ The following parameters may be provided in section `snapshots`:
- `delay`: how many states to delay making the snapshot; it must be considerably smaller than `stateManager.pruningMinStatesToKeep`.
The default is 20.
- `localPath`: the path to the snapshots folder in this node's disk. Default is `waspdb/snap`.
- `networkPaths`: the comma separated list of paths to the remote (http(s)) snapshot locations. The list is empty by default.
- `networkPaths`: the comma-separated list of URLs that serve snapshots. The URLs may have the HTTP (e.g., `http://server.org/path/`) or the HTTPS
(e.g., `https://server.org/path/`) scheme for remote locations or a file path (e.g., `file://path/to/folder`) scheme for local snapshot locations.
The scheme is compulsory in the URL. The list is empty by default.

### WAL

Expand Down