interchain-security

module
v2.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 16, 2023 License: Apache-2.0

README

Interchain Security

Go Report Card Security Rating Vulnerabilities Bugs Lines of Code Coverage

interchain-security contains a working and in-production implementation of the Replicated Security protocol (aka Interchain Security V1). Replicated security is an open sourced IBC application which allows cosmos blockchains to lease their proof-of-stake security to one another.

For more details on the Replicated Security protocol, take a look at the docs or technical specification.

Instructions

Prerequisites

## For OSX or Linux

# go 1.18 (https://formulae.brew.sh/formula/go)
brew install go@1.19
# jq (optional, for testnet) (https://formulae.brew.sh/formula/jq)
brew install jq
# docker (optional, for integration tests, testnet) (https://docs.docker.com/get-docker/)

Installing and running binaries

# install interchain-security-pd and interchain-security-cd binaries
make install
# run provider
interchain-security-pd
# run consumer
interchain-security-cd
# (if the above fail, ensure ~/go/bin on $PATH)
export PATH=$PATH:$(go env GOPATH)/bin

Inspect the Makefile if curious.

Testing

See testing docs.

Learn more

Directories

Path Synopsis
app
params
Package params defines the simulation parameters in the gaia.
Package params defines the simulation parameters in the gaia.
cmd
legacy_ibc_testing
tests
e2e
testutil
keeper
Package keeper is a generated GoMock package.
Package keeper is a generated GoMock package.
simibc
simibc is a collection of utilities wrapping the ibc-go testing framework which make is easier to write test scenarios involving precise orders of packet and ack delivery and calls to BeginBlock and EndBlock.
simibc is a collection of utilities wrapping the ibc-go testing framework which make is easier to write test scenarios involving precise orders of packet and ack delivery and calls to BeginBlock and EndBlock.
x
ccv/consumer/types
Package types is a reverse proxy.
Package types is a reverse proxy.
ccv/democracy/distribution
Package distribution defines a "wrapper" module around the Cosmos SDK's native x/distribution module.
Package distribution defines a "wrapper" module around the Cosmos SDK's native x/distribution module.
ccv/democracy/governance
Package governance defines a "wrapper" module around the Cosmos SDK's native x/governance module.
Package governance defines a "wrapper" module around the Cosmos SDK's native x/governance module.
ccv/democracy/staking
Package staking defines a "wrapper" module around the Cosmos SDK's native x/staking module.
Package staking defines a "wrapper" module around the Cosmos SDK's native x/staking module.
ccv/provider/types
Package types is a reverse proxy.
Package types is a reverse proxy.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL