README
¶
Teleport
Teleport is a scalable, high-throughput Proof-of-Stake blockchain that is fully compatible and interoperable with Ethereum. It's built using the Cosmos SDK which runs on top of Tendermint Core consensus engine.
Note: Requires Go 1.17+
Installation
For prerequisites and detailed build instructions please read the Installation instructions. Once the dependencies are installed, run:
make install
Or check out the latest release.
Quick Start
To learn how the Teleport works from a high-level perspective, go to the Introduction section from the documentation. You can also check the instructions to Run a Node.
Contributing
Looking for a good place to start contributing? Check out some good first issues.
For additional instructions, standards and style guides, please refer to the Contributing document.
Directories
¶
| Path | Synopsis |
|---|---|
|
client
|
|
|
docs/statik
Package statik contains static assets.
|
Package statik contains static assets. |
|
cmd
|
|
|
network
Package network implements and exposes a fully operational in-process Tendermint test network that consists of at least one or potentially many validators.
|
Package network implements and exposes a fully operational in-process Tendermint test network that consists of at least one or potentially many validators. |
|
x
|
|
|
aggregate/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
rvesting/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
xibc/clients/light-clients/tendermint
Package tendermint implements a concrete `ConsensusState`, `Header`, `Misbehaviour` and `Equivocation` types for the Tendermint consensus light client.
|
Package tendermint implements a concrete `ConsensusState`, `Header`, `Misbehaviour` and `Equivocation` types for the Tendermint consensus light client. |
|
xibc/core/client
The main type is `Client`, which provides `commitment.Root` to verify state proofs and `ConsensusState` to verify header proofs.
|
The main type is `Client`, which provides `commitment.Root` to verify state proofs and `ConsensusState` to verify header proofs. |
|
xibc/core/client/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
xibc/core/packet/types
Package types is a reverse proxy.
|
Package types is a reverse proxy. |
|
xibc/testing/mock
This package is only intended to be used for testing core XIBC.
|
This package is only intended to be used for testing core XIBC. |
Click to show internal directories.
Click to hide internal directories.