Skip to content

petri-labs/petrichor

Repository files navigation

🤝 Petrichor

Litepaper · Technical Documentation · Integration Guide


x/petrichor interchain security

The Petrichor module is part of the Interchain Security (Cosmos Shared Security that benefits from the IBC standard). Petrichor is a friction free Interchain Security solution because there is no necessity to share hardware resources, have the blockchains synchronized nor modify the core of the origin chain that provide Interchain Security. Petrichor module introduces the concept of petrichor coins that can be seen as foreign coins bridged thru an IBC channel (ICS-004), whitelisted with the help of on-chain governance in the Petrichor module and delegated by users or smart contracts to the active set of network validators.

Delegators of the petrichor coins will be subjected to similar rules as the delegators of native coins but these delegators will provide Interchain Security to the network. The previously mentioned foreign coins can be in the form of Liquid Staked Derivative that benefits from the inflation of its native chain or any type of coin that can be bridged through the previously mentioned channels respecting the ICS-020 standard.

When users delegate coins through the Petrichor module the voting power of the validators will be diluted, as a consequence, bad actors will have to increase their capital spendings to try and corrupt the consensus of the blockchain.

By design, x/petrichor use the following CosmosSDK modules to implement interchain security to a new or existing blockchain :

Development environment

This project uses Go v1.18 and was bootstrapped with Ignite CLI v0.25.1.

To run the local development environment use:

$ ignite chain serve --verbose

If you want to build a binary ready to use:

$ ignite chain build

To build the proto files:

$ ignite generate proto-go

Localnet

Docker orchestration to create a local network with 3 docker containers:

  • localnet-start: stop the testnet if running, build the terra-money/localnet-petrichor image and start the nodes.
  • localnet-petrichor-rmi: removes the previously created terra-money/localnet-petrichor image.
  • localnet-build-env: delete and rebuild the terra-money/localnet-petrichor
  • localnet-build-nodes: using the terra-money/localnet-petrichor starts a 3 docker containers testnet.
  • localnet-stop: stop the testnet if running.

Install

To install the latest version of your blockchain node's binary, execute the following command on your machine:

curl https://get.ignite.com/username/petrichor@latest! | sudo bash

username/petrichor should match the username and repo_name of the Github repository to which the source code was pushed. Learn more about the install process.

Join Testnet

Joining the testnet is a very standardized process cosmos chain. In this case you will have to use petrichord and follow Terra documentation since it's the same process but replacing it's genesis with the one that you can find in this repo under the path docs/testnet/genesis.json and the following seeds,

Running the simulation

The simulation app does not run out of the box since the petrichor module owns all native stake. The x/staking module's operation.go file panics when a delegator does not have a private key.

In order to run the simulation, you can update the x/staking module directly before compiling the simulation app using the following command

go mod vendor
sed -i '' 's/fmt.Errorf("delegation addr: %s does not exist in simulation accounts", delAddr)/nil/g' vendor/github.com/cosmos/cosmos-sdk/x/staking/simulation/operations.go
ignite chain simulate

Learn more

Warning

Please note that this is a beta version of the which still undergoing final testing before its official release. TFL does not give any warranties, whether express or implied, as to the suitability or usability of the software or any of its content.

TFL will not be liable for any loss, whether such loss is direct, indirect, special or consequential, suffered by any party as a result of their use of the software or content.

Should you encounter any bugs, glitches, lack of functionality or other problems on the website, please submit bugs and feature requests through Github Issues.