-
Notifications
You must be signed in to change notification settings - Fork 367
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: prepare release candidate for iavl v1 (#2013)
* docs: prepare release candidate for iavl v1 includes first pass migration instructions for upgrading to iavl v1.
- Loading branch information
1 parent
6b5e1e9
commit 2c2a3a3
Showing
2 changed files
with
96 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# IAVL V1 | ||
|
||
**IAVL V1 is a work in progress. Proceed at your own risk until a non-alpha version is tagged.** | ||
|
||
IAVL V1 is an updated data format for the low-level storage of application data in the Kava blockchain. | ||
The change in format results in much more performant syncing of the chain, and greatly reduced the | ||
storage footprint required for Kava nodes. | ||
|
||
Steps for using IAVL V1: | ||
|
||
**For `goleveldb` nodes:** | ||
1. Replace or recreate your node data with IAVL V1: see [Data](#data). | ||
2. Install an IAVL V1 binary: | ||
```sh | ||
git checkout v0.26.2-alpha.0 | ||
make install | ||
``` | ||
3. Start kava as usual: `kava start` | ||
|
||
**For `rocksdb` nodes:** | ||
1. Replace or recreate your node data with IAVL V1: see [Data](#data). | ||
2. Update your default memory allocator: see [default memory allocator](#default-memory-allocator) | ||
3. Install an IAVL V1 binary: | ||
```sh | ||
git checkout v0.26.2-alpha.0 | ||
make install COSMOS_BUILD_OPTIONS=rocksdb | ||
``` | ||
4. Start kava with the desired memory allocator: `LD_PRELOAD=/path/to/tcmalloc kava start` | ||
|
||
## Data | ||
|
||
The IAVL V1 binaries are compatible with IAVL V0 data (all chain data snapshots available up until this time). | ||
However, for maximum performance & storage benefit, node operators should use data that is completely | ||
built with IAVL V1. | ||
|
||
### Validators & Pruning nodes | ||
|
||
For nodes with minimal historical state, we recommend bootstrapping your node with statesync. | ||
For an example of how to setup a node with statesync, see [here](https://www.polkachu.com/state_sync/kava). | ||
|
||
A public RPC server is available at `https://rpc.kava.io:443`. | ||
|
||
### Full-archive node | ||
|
||
For nodes with the complete historical data, we expect to release archive data snapshots in the coming weeks. Stay tuned. | ||
|
||
## Default memory allocator | ||
|
||
For nodes using rocksdb, greatly improved memory performance was seen when using [`tcmalloc`](https://github.com/google/tcmalloc) | ||
as the memory allocator. | ||
|
||
To update your node to use `tcmalloc`: | ||
1. install `tcmalloc` | ||
* via gperftools collection package (recommended) | ||
* package manager: `apt-get install google-perftools` | ||
* [gperftools Releases](https://github.com/gperftools/gperftools/releases) | ||
* from source: see [tcmalloc Quickstart](https://google.github.io/tcmalloc/quickstart.html) | ||
2. whenever running kava, do so with the new memory allocator: `LD_PRELOAD=/path/to/tcmalloc kava start` | ||
* replace `/path/to/tcmalloc` above with correct path |