Skip to content

Commit

Permalink
fix paths
Browse files Browse the repository at this point in the history
  • Loading branch information
drahnr committed Feb 10, 2025
1 parent 04dca08 commit 85ac7cb
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 17 deletions.
20 changes: 10 additions & 10 deletions crates/node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ Fendermint is an effort to implement [IPC with Tendermint Core](https://docs.goo

## Quick Start

- [Local testnets](../docs/client/localnet.md)
- [Local testnets](../docs/fendermint/localnet.md)

## Docs

Please have a look in the [docs](../docs/client/README.md) to see an overview of the project, how to run the components, and previous demos.
Please have a look in the [docs](../docs/fendermint/README.md) to see an overview of the project, how to run the components, and previous demos.

## IPC

Fendermint is built with support for [IPC](https://github.com/consensus-shipyard/ipc) by design. If you are looking to deploy the infrastructure Fendermint-based IPC subnet, refer to the [IPC main repo](https://github.com/consensus-shipyard/ipc), or have a look at the [IPC infrastructure docs](../docs/client/ipc.md).
Fendermint is built with support for [IPC](https://github.com/consensus-shipyard/ipc) by design. If you are looking to deploy the infrastructure Fendermint-based IPC subnet, refer to the [IPC main repo](https://github.com/consensus-shipyard/ipc), or have a look at the [IPC infrastructure docs](../docs/node/ipc.md).

## Testing

Expand All @@ -27,24 +27,24 @@ make test
```

while the next command builds docker images and runs an end-to-end test using the
[SimpleCoin](./client/rpc/examples/simplecoin.rs) and the
[ethers](./client/eth/api/examples/ethers.rs) examples:
[SimpleCoin](./node/rpc/examples/simplecoin.rs) and the
[ethers](./node/eth/api/examples/ethers.rs) examples:

```bash
make e2e
```

## IPC Solidity Actors

We generate Rust contract-bindings for the Solidity actors we need to invoke from the [contracts](../contracts/) folder, some of which are deployed during the genesis process. The contract-bindings live in [contracts/contract-bindings/](../contracts/binding), and are generated automatically during the build, or with the following command:
We generate Rust contract-bindings for the Solidity actors we need to invoke from the [contracts](../../contracts/) folder, some of which are deployed during the genesis process. The contract-bindings live in [contracts/contract-bindings/](../contracts/binding), and are generated automatically during the build, or with the following command:

```bash
make gen
```

To run it, you will have to install [forge](https://book.getfoundry.sh/getting-started/installation).

The list of contracts for which we generate Rust contract-bindings are in [build.rs](../contracts/contract-bindings/build.rs) and needs to be maintained by hand, for example if a new "diamond facet" is added to a contract, it has to be added here. Diamond facets also have to be added manually in [ipc.rs](./vm/actor_interface/src/ipc.rs) where the contracts which need to be deployed during genesis are described. These facets cannot be divined from the ABI description, so they have to be maintained explicitly.
The list of contracts for which we generate Rust contract-bindings are in [build.rs](../contract-bindings/build.rs) and needs to be maintained by hand, for example if a new "diamond facet" is added to a contract, it has to be added here. Diamond facets also have to be added manually in [ipc.rs](./vm/actor_interface/src/ipc.rs) where the contracts which need to be deployed during genesis are described. These facets cannot be divined from the ABI description, so they have to be maintained explicitly.

To test whether the genesis process works, we can run the following unit test:

Expand All @@ -65,7 +65,7 @@ See the [docker docs](./docker/README.md) for more details about the build.

### Pre-built Docker Image

The CI build publishes a [Docker image](https://github.com/consensus-shipyard/client/pkgs/container/fendermint) to Github Container Registry upon a successful build on the `main` branch. This is the same image as the one used in the End-to-End tests; it contains the built-in actor bundle and IPC Solidity actors, ready to be deployed during genesis.
The CI build publishes a [Docker image](https://github.com/consensus-shipyard/node/pkgs/container/fendermint) to Github Container Registry upon a successful build on the `main` branch. This is the same image as the one used in the End-to-End tests; it contains the built-in actor bundle and IPC Solidity actors, ready to be deployed during genesis.

The image can be pulled with the following command:

Expand Down Expand Up @@ -96,12 +96,12 @@ The location of the configuration directory is determined by [Options::config_di

The `--config-dir` can be used in combination with `--home-dir` and the pre-build docker image to:
1. set `--home-dir` to a custom mounted volume where the data files can persist
2. set `--config-dir` to `/client/config`, which is where the `runner.Dockerfile` places the `default.toml` file
2. set `--config-dir` to `/node/config`, which is where the `runner.Dockerfile` places the `default.toml` file
3. mount any custom config files next to `default.toml` in the container

This way the `default.toml` that the image comes with is always active. Without setting `--config-dir` the operator would have to put it in the mounted `--home-dir`.

Alternatively individual paths for the relative directories inside the config can be mounted, e.g. `/client/data`, `/client/snapshots`, etc.
Alternatively individual paths for the relative directories inside the config can be mounted, e.g. `/node/data`, `/node/snapshots`, etc.

### Environment Variables

Expand Down
12 changes: 6 additions & 6 deletions crates/node/testing/benchmarks/state-size/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,28 +28,28 @@ make stats plots
For example:

```console
  ~/projects/consensuslab/ipc/client/testing/benchmarks/state-size  …798-benchmark-state-size ⇣1 ⇡1 ?4 ···················································································  1.77.0 10:11:25
  ~/projects/consensuslab/ipc/node/testing/benchmarks/state-size  …798-benchmark-state-size ⇣1 ⇡1 ?4 ···················································································  1.77.0 10:11:25
make stats plots
/home/aakoshh/projects/consensuslab/ipc/client/testing/benchmarks/state-size/scripts/stats.sh /home/aakoshh/projects/consensuslab/ipc/client/testing/benchmarks/state-size/measurements/state-size-15-false.jsonline > /home/aakoshh/projects/consensuslab/ipc/client/testing/benchmarks/state-size/measurements/state-size-15-false.stats
/home/aakoshh/projects/consensuslab/ipc/client/testing/benchmarks/state-size/measurements/state-size-0-true.stats
/home/aakoshh/projects/consensuslab/ipc/node/testing/benchmarks/state-size/scripts/stats.sh /home/aakoshh/projects/consensuslab/ipc/node/testing/benchmarks/state-size/measurements/state-size-15-false.jsonline > /home/aakoshh/projects/consensuslab/ipc/node/testing/benchmarks/state-size/measurements/state-size-15-false.stats
/home/aakoshh/projects/consensuslab/ipc/node/testing/benchmarks/state-size/measurements/state-size-0-true.stats
{
"block_height": 10278,
"db_size_kb": 60740,
"avg_growth_kb": 5.131840311587147
}
/home/aakoshh/projects/consensuslab/ipc/client/testing/benchmarks/state-size/measurements/state-size-15-false.stats
/home/aakoshh/projects/consensuslab/ipc/node/testing/benchmarks/state-size/measurements/state-size-15-false.stats
{
"block_height": 381,
"db_size_kb": 8236,
"avg_growth_kb": 0.6170212765957447
}
/home/aakoshh/projects/consensuslab/ipc/client/testing/benchmarks/state-size/measurements/state-size-15-true.stats
/home/aakoshh/projects/consensuslab/ipc/node/testing/benchmarks/state-size/measurements/state-size-15-true.stats
{
"block_height": 2630,
"db_size_kb": 21200,
"avg_growth_kb": 5.0248946763692075
}
/home/aakoshh/projects/consensuslab/ipc/client/testing/benchmarks/state-size/scripts/growth-plot.sh /home/aakoshh/projects/consensuslab/ipc/client/testing/benchmarks/state-size/measurements/state-size-15-false.png /home/aakoshh/projects/consensuslab/ipc/client/testing/benchmarks/state-size/measurements/state-size-15-false.jsonline
/home/aakoshh/projects/consensuslab/ipc/node/testing/benchmarks/state-size/scripts/growth-plot.sh /home/aakoshh/projects/consensuslab/ipc/node/testing/benchmarks/state-size/measurements/state-size-15-false.png /home/aakoshh/projects/consensuslab/ipc/node/testing/benchmarks/state-size/measurements/state-size-15-false.jsonline
```

The filename indicates the parameters with with the measurements were taken, e.g. `-0-true` means that all app state history
Expand Down
2 changes: 1 addition & 1 deletion crates/node/testing/materializer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ The ports get allocated from 30000 onward, 100 range to each node, so the last t
#### Logs

For troubleshooting we can look at the logs, either by using `docker logs` and the container name, or for the `fendermint` container we can also access the logs:
* `less testing/materializer/tests/docker-materializer-data/testnets/layer2/root/nodes/brussels/client/logs/fendermint.2024-03-11.log`
* `less testing/materializer/tests/docker-materializer-data/testnets/layer2/root/nodes/brussels/node/logs/fendermint.2024-03-11.log`
* `docker logs brussels-fendermint-955632`


Expand Down

0 comments on commit 85ac7cb

Please sign in to comment.