Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update readme with latest crate structure #539

Merged
merged 1 commit into from
Nov 3, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 27 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,39 +24,41 @@ knows, maybe even a full node in a far away future).

The repository is organized as a Cargo workspace. Each _Pallas_ "building block" lives in its own crate. The root `pallas` crate serves as an all-in-one dependency that re-exports all of the other modules in an hierarchically organized fashion, using Cargo `features` to tailor the setup for each use-case.

As already explained, _Pallas_ aims at being an expanding set of components. The following tables describe the currently available crates, as well as the planned ones.
### Core

### Ouroboros Network
| Crates | Description |
| ------------------------------- | -------------------------------------------------- |
| [pallas-codec](/pallas-codec) | Shared CBOR encoding / decoding using minicbor lib |
| [pallas-crypto](/pallas-crypto) | Shared Cryptographic primitives |
| [pallas-math](/pallas-math) | Shared mathematics functions |

| Crates | Description |
| --------------------------------- | ----------------------------------------------------------------------- |
| [pallas-network](/pallas-network) | Network stack providing a multiplexer and mini-protocol implementations |
### Network

### Ouroboros Consensus
| Crates | Description |
| --------------------------------- | --------------------------------------------------------------------- |
| [pallas-network](/pallas-network) | Network stack providing multiplexer and mini-protocol implementations |

| Crates | Description |
| ----------------- | --------------------------------------------------------- |
| pallas-leadership | Implementation of the slot leadership selection algorithm |
| pallas-selection | Implementation of the consensus chain-selection algorithm |
### Ledger

### Cardano Ledger
| Crates | Description |
| --------------------------------------- | --------------------------------------------------------------- |
| [pallas-primitives](/pallas-primitives) | Ledger primitives and cbor codec for the different Cardano eras |
| [pallas-traverse](/pallas-traverse) | Utilities to traverse over multi-era block data |
| [pallas-addresses](/pallas-addresses) | Encode / decode Cardano addresses of any type |

| Crates | Description |
| --------------------------------------- | ----------------------------------------------------------------------- |
| [pallas-primitives](/pallas-primitives) | Ledger primitives and cbor codec for the different Cardano eras |
| [pallas-traverse](/pallas-traverse) | Utilities to traverse over multi-era block data |
| [pallas-addresses](/pallas-addresses) | Encode / decode Cardano addresses of any type |
| pallas-ticking | Time passage implementation for consensus algorithm |
| pallas-applying | Logic for validating and applying new blocks and txs to the chain state |
| pallas-forecasting | Ledger forecasting algorithm to be used by the consensus layer |
### Wallet

### Shared
| Crates | Description |
| ------------------------------------- | ------------------------------------------ |
| [pallas-wallet](/pallas-wallet) | Wallet utilities for secure key management |
| [pallas-txbuilder](/pallas-txbuilder) | Ergonomic transaction builder |

| Crates | Description |
| ------------------------------- | -------------------------------------------------- |
| [pallas-crypto](/pallas-crypto) | Shared Cryptographic primitives |
| [pallas-codec](/pallas-codec) | Shared CBOR encoding / decoding using minicbor lib |
| [pallas-math](/pallas-math) | Shared mathematics functions |
## Interop

| Crates | Description |
| --------------------------------- | ----------------------------------------------------------------------------------- |
| [pallas-hardano](/pallas-hardano) | Interoperability with implementation-specific artifacts of the Haskell Cardano node |
| [pallas-utxorpc](/pallas-utxorpc) | Interoperability with the [UTxO RPC](https://utxorpc.org) specification |

## Etymology

Expand Down
Loading