Skip to content

Commit

Permalink
chore: rename decoder crate
Browse files Browse the repository at this point in the history
  • Loading branch information
suchapalaver committed Dec 20, 2024
1 parent db25d57 commit e13870b
Show file tree
Hide file tree
Showing 20 changed files with 39 additions and 39 deletions.
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"crates/vee": "0.1.0",
"crates/flat-files-decoder": "0.1.0",
"crates/decoder": "0.1.0",
"crates/header-accumulator": "0.1.0",
"crates/firehose-protos": "0.1.0",
"crates/firehose-protos-examples": "0.1.0"
Expand Down
48 changes: 24 additions & 24 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ criterion = { version = "0.5.1", features = ["html_reports"] }
ethportal-api = { git = "https://github.com/ethereum/trin.git", version = "0.2.2", tag = "v0.1.0-alpha.51" }
firehose-protos = { path = "crates/firehose-protos", version = "0.1.0" }
firehose-rs = { git = "https://github.com/semiotic-ai/firehose-rs.git", branch = "main" }
flat-files-decoder = { path = "crates/flat-files-decoder", version = "0.1.0" }
decoder = { path = "crates/decoder", version = "0.1.0" }
header-accumulator = { path = "crates/header-accumulator", version = "0.1.0" }
hex = "0.4.3"
primitive-types = "0.12.2"
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ Semiotic Labs monorepo for Verifiable Extraction of blockchain data.
[vee](./crates/vee/README.md) is the main crate for the project. It re-exports:

- [firehose-protos](./crates/firehose-protos/README.md)
- [flat-files-decoder](./crates/flat-files-decoder/README.md)
- [decoder](./crates/decoder/README.md)
- [header-accumulator](./crates/header-accumulator/README.md)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[package]
name = "flat-files-decoder"
name = "decoder"
version = "0.1.0"
edition = "2021"

Expand Down
10 changes: 5 additions & 5 deletions crates/flat-files-decoder/README.md → crates/decoder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Check out the crate documentation in your browser by running, from
the root of the `veemon` workspace:

```terminal
cd crates/flat-files-decoder && cargo doc --open
cd crates/decoder && cargo doc --open
```

## Running CLI Example
Expand All @@ -35,25 +35,25 @@ Here are some examples of how to use the commands:
1. To stream data continuously from `stdin`:

```terminal
cargo run -p flat-files-decoder --example cli stream
cargo run -p decoder --example cli stream
```

```terminal
cat example0017686312.dbin | cargo run -p flat-files-decoder --example cli stream
cat example0017686312.dbin | cargo run -p decoder --example cli stream
```

This will output decoded header records as bytes into `stdout`

1. To check a folder of dbin files:

```terminal
cargo run -p flat-files-decoder --example cli decode --input ./input_files/ --compression true
cargo run -p decoder --example cli decode --input ./input_files/ --compression true
```

So, if using test data from a `test-assets/` folder in the root of the `veemon` repo:

```terminal
cargo run -p flat-files-decoder --example cli decode --input test-assets/benchmark_files/pre_merge
cargo run -p decoder --example cli decode --input test-assets/benchmark_files/pre_merge
```

This will store the block headers as json format in the output folder.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion crates/firehose-protos/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Representation of the tracing of a block in the Ethereum blockchain.
## Usage

To ingest these block types from flat files, check out
[`veemon/crates/flat-files-decoder`](../flat-files-decoder/index.html).
[`veemon/crates/decoder`](../decoder/index.html).

For a high-level Rust client to use with Firehose endpoint providers like Pinax or StremaingFast,
check out [`semiotic-ai/firehose-client`](https://github.com/semiotic-ai/firehose-client).
2 changes: 1 addition & 1 deletion crates/header-accumulator/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ trin-validation.workspace = true
thiserror.workspace = true

[dev-dependencies]
flat-files-decoder.workspace = true
decoder.workspace = true
tempfile.workspace = true
4 changes: 2 additions & 2 deletions crates/header-accumulator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,12 @@ cd crates/header-accumulator && cargo doc --open

The main objective of this library is to provide a tool for verifying
blocks from [StreamingFast Firehose](https://firehose.streamingfast.io/).
It works in conjunction with [flat-files-decoder](https://github.com/semiotic-ai/flat-files-decoder)
It works in conjunction with [decoder](https://github.com/semiotic-ai/decoder)
to offer a comprehensive solution.

## Testing

Some tests depend on [flat-files-decoder](../flat-files-decoder/README.md) as a development dependency.
Some tests depend on [decoder](../decoder/README.md) as a development dependency.

Run all tests with:

Expand Down
2 changes: 1 addition & 1 deletion crates/vee/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ name = "vee"

[dependencies]
firehose-protos.workspace = true
flat-files-decoder.workspace = true
decoder.workspace = true
header-accumulator.workspace = true

[dev-dependencies]
Expand Down
2 changes: 1 addition & 1 deletion release-please-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
],
"packages": {
"crates/vee": {},
"crates/flat-files-decoder": {},
"crates/decoder": {},
"crates/header-accumulator": {},
"crates/firehose-protos": {},
"crates/firehose-protos-examples": {}
Expand Down

0 comments on commit e13870b

Please sign in to comment.