-
Notifications
You must be signed in to change notification settings - Fork 207
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6278d1a
commit 5dd7481
Showing
1 changed file
with
87 additions
and
86 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,86 +1,87 @@ | ||
| <!-- | ||
| parent: | ||
| order: false | ||
| --> | ||
|
|
||
| <div align="center"> | ||
| <h1> <img src="https://user-images.githubusercontent.com/2770565/223762290-44afc792-8ad4-4dbb-b2c2-532780d6c5de.png" alt="Logo" width="30" height="25"> Lava Network </h1> | ||
| </div> | ||
|
|
||
|  | ||
|
|
||
| ### What is Lava? | ||
|
|
||
| The Lava Protocol aims to provide decentralized and scalable access to blockchain data through the use of a network of providers and consumers. It utilizes a proof-of-stake consensus mechanism and incentivizes participants through the use of its native LAVA token. The protocol includes features such as a stake-weighted pseudorandom pairing function, backfilling, and a lazy settlement process to improve scalability and efficiency. The roadmap for the Lava Protocol includes further development of governance, conflict resolution, privacy, and quality of service, as well as support for additional API specifications. It is designed to be a public good that enables decentralized access to the Web3 ecosystem. | ||
|
|
||
| Read more about Lava in the [whitepaper](http://lavanet.xyz/whitepaper) and visit the [Docs](https://docs.lavanet.xyz?utm_source=github.com&utm_medium=github&utm_campaign=readme) | ||
|
|
||
| ## Lava blockchain | ||
|
|
||
| Lava is built using the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk/) which runs on top of [Tendermint Core](https://github.com/tendermint/tendermint) consensus engine. | ||
|
|
||
| [Documentation](x/README.md) | ||
|
|
||
| **Note**: Requires [Go 1.20.5](https://golang.org/dl/) | ||
|
|
||
| ## Quick Start | ||
|
|
||
| The best way to start working with lava is to use docker, for additional reading go to: | ||
| [Running via compose](docker/README.md) | ||
|
|
||
| ## Contributing | ||
|
|
||
| See [CONTRIBUTING.md](./CONTRIBUTING.md) for details on how to contribute. If you want to follow the updates or learn more about the latest design then join our [Discord](https://discord.gg/lavanetxyz). | ||
|
|
||
| ## Developing | ||
|
|
||
| ### Installing development dependencies | ||
|
|
||
| before running the scripts make sure you have go installed and added to $PATH, you can validate by running `which go` | ||
| init_install will install all necessary dependencies to develop on lava. | ||
|
|
||
| ```bash | ||
| ./scripts/init_install.sh | ||
| ``` | ||
|
|
||
| ### Building the binaries | ||
|
|
||
| LAVA_BINARY=all will build all lava binaries (lavad, lavap, lavavisor) and place them in the go bin path on your environment. | ||
|
|
||
| ```bash | ||
| LAVA_BINARY=all make install | ||
| ``` | ||
|
|
||
| #### Building the binaries locally | ||
|
|
||
| You can also build the binaries locally (path will be ./build/...) by running | ||
|
|
||
| ```bash | ||
| LAVA_BINARY=all make build | ||
| ``` | ||
|
|
||
| #### Building only a specific binary | ||
|
|
||
| it is possible to build only one binary: lavad/lavap/lavavisor | ||
|
|
||
| ```bash | ||
| LAVA_BINARY=lavad make install | ||
| ``` | ||
|
|
||
| Or check out the latest [release](https://github.com/lavanet/lava/releases). | ||
|
|
||
| ### Add `lavad`/`lavap` autocomplete | ||
|
|
||
| You can add a useful autocomplete feature to `lavad` & `lavap` with a simple bash [script](https://github.com/lavanet/lava/blob/main/scripts/lava_auto_completion_install.sh). | ||
|
|
||
| ## Join Lava | ||
|
|
||
| Join Lava's testnet, [read instructions here](https://docs.lavanet.xyz/testnet?utm_source=github.com&utm_medium=github&utm_campaign=readme) | ||
|
|
||
| ⚠️ THERE'S NO MAINNET LAVA TOKEN, BE AWARE OF SCAMS. | ||
|
|
||
| ## Community | ||
|
|
||
| - [Github Discussions](https://github.com/lavanet/lava/discussions) | ||
| - [Discord](https://discord.gg/lavanetxyz) | ||
| - [Twitter](https://twitter.com/lavanetxyz) | ||
| Test | ||
| <!-- | ||
| parent: | ||
| order: false | ||
| --> | ||
|
|
||
| <div align="center"> | ||
| <h1> <img src="https://user-images.githubusercontent.com/2770565/223762290-44afc792-8ad4-4dbb-b2c2-532780d6c5de.png" alt="Logo" width="30" height="25"> Lava Network </h1> | ||
| </div> | ||
|
|
||
|  | ||
|
|
||
| ### What is Lava? | ||
|
|
||
| The Lava Protocol aims to provide decentralized and scalable access to blockchain data through the use of a network of providers and consumers. It utilizes a proof-of-stake consensus mechanism and incentivizes participants through the use of its native LAVA token. The protocol includes features such as a stake-weighted pseudorandom pairing function, backfilling, and a lazy settlement process to improve scalability and efficiency. The roadmap for the Lava Protocol includes further development of governance, conflict resolution, privacy, and quality of service, as well as support for additional API specifications. It is designed to be a public good that enables decentralized access to the Web3 ecosystem. | ||
|
|
||
| Read more about Lava in the [whitepaper](http://lavanet.xyz/whitepaper) and visit the [Docs](https://docs.lavanet.xyz?utm_source=github.com&utm_medium=github&utm_campaign=readme) | ||
|
|
||
| ## Lava blockchain | ||
|
|
||
| Lava is built using the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk/) which runs on top of [Tendermint Core](https://github.com/tendermint/tendermint) consensus engine. | ||
|
|
||
| [Documentation](x/README.md) | ||
|
|
||
| **Note**: Requires [Go 1.20.5](https://golang.org/dl/) | ||
|
|
||
| ## Quick Start | ||
|
|
||
| The best way to start working with lava is to use docker, for additional reading go to: | ||
| [Running via compose](docker/README.md) | ||
|
|
||
| ## Contributing | ||
|
|
||
| See [CONTRIBUTING.md](./CONTRIBUTING.md) for details on how to contribute. If you want to follow the updates or learn more about the latest design then join our [Discord](https://discord.gg/lavanetxyz). | ||
|
|
||
| ## Developing | ||
|
|
||
| ### Installing development dependencies | ||
|
|
||
| before running the scripts make sure you have go installed and added to $PATH, you can validate by running `which go` | ||
| init_install will install all necessary dependencies to develop on lava. | ||
|
|
||
| ```bash | ||
| ./scripts/init_install.sh | ||
| ``` | ||
|
|
||
| ### Building the binaries | ||
|
|
||
| LAVA_BINARY=all will build all lava binaries (lavad, lavap, lavavisor) and place them in the go bin path on your environment. | ||
|
|
||
| ```bash | ||
| LAVA_BINARY=all make install | ||
| ``` | ||
|
|
||
| #### Building the binaries locally | ||
|
|
||
| You can also build the binaries locally (path will be ./build/...) by running | ||
|
|
||
| ```bash | ||
| LAVA_BINARY=all make build | ||
| ``` | ||
|
|
||
| #### Building only a specific binary | ||
|
|
||
| it is possible to build only one binary: lavad/lavap/lavavisor | ||
|
|
||
| ```bash | ||
| LAVA_BINARY=lavad make install | ||
| ``` | ||
|
|
||
| Or check out the latest [release](https://github.com/lavanet/lava/releases). | ||
|
|
||
| ### Add `lavad`/`lavap` autocomplete | ||
|
|
||
| You can add a useful autocomplete feature to `lavad` & `lavap` with a simple bash [script](https://github.com/lavanet/lava/blob/main/scripts/lava_auto_completion_install.sh). | ||
|
|
||
| ## Join Lava | ||
|
|
||
| Join Lava's testnet, [read instructions here](https://docs.lavanet.xyz/testnet?utm_source=github.com&utm_medium=github&utm_campaign=readme) | ||
|
|
||
| ⚠️ THERE'S NO MAINNET LAVA TOKEN, BE AWARE OF SCAMS. | ||
|
|
||
| ## Community | ||
|
|
||
| - [Github Discussions](https://github.com/lavanet/lava/discussions) | ||
| - [Discord](https://discord.gg/lavanetxyz) | ||
| - [Twitter](https://twitter.com/lavanetxyz) |