chore: Write agent app README #75
Conversation
| 3. **Configuration File**: | ||
|
|
||
| - The agent also requires a YAML configuration file. The path to this file must be specified in the `.env` file via `EBO_AGENT_CONFIG_FILE_PATH`. | ||
| - To set up the configuration, copy `config.example.yml` to `config.yml`: |
There was a problem hiding this comment.
I'm not sure if we should add explanatory comments inside the config.example.yml file for each of its properties or to add some kind of doc here. I feel like adding comments inside the yml file might be easier to update as they'd be super co-located.
There was a problem hiding this comment.
Added comments in config.example.yml
apps/agent/README.md
Outdated
| - Create a `.env` file in the root of the `agent` package. Refer to `.env.example` for the required environment variables. | ||
| - Populate the file with your environment-specific settings: |
There was a problem hiding this comment.
Creating a .env file is optional, users could (and probably should but it's up to them) use env vars directly while running the agent. Let's rephrase this one just to show that's not a must to use a .env file
There was a problem hiding this comment.
Mentioned the option to use the env vars directly
apps/agent/config.example.yml
Outdated
| blockByTime: /sf.blockmeta.v2.BlockByTime # Endpoint for block by time service | ||
| block: /sf.blockmeta.v2.Block # Endpoint for block service |
There was a problem hiding this comment.
| blockByTime: /sf.blockmeta.v2.BlockByTime # Endpoint for block by time service | |
| block: /sf.blockmeta.v2.Block # Endpoint for block service | |
| blockByTime: /sf.blockmeta.v2.BlockByTime # Substream's endpoint for "block by time" service | |
| block: /sf.blockmeta.v2.Block # Substream's endpoint for "block" service |
apps/agent/README.md
Outdated
| | Variable | Description | Required | | ||
| | ------------------------------- | ----------------------------------------- | -------- | | ||
| | `PROTOCOL_PROVIDER_PRIVATE_KEY` | Private key for the Protocol Provider | Yes | | ||
| | `BLOCK_NUMBER_BLOCKMETA_TOKEN` | BlockmetaBlockNumberService bearer token | Yes | |
There was a problem hiding this comment.
Now that I'm thinking, it'd be nice to add a link or something like that so potential contributors have at least some idea on how to get this token (was something that we struggled with)
Here are two of the main resources that we've used:
- https://docs.substreams.dev/documentation/consume/authentication for a to-do on how to generate a token.
- https://thegraph.market/ to check the list of substreams providers with their URLs.
Mind adding some footnotes for this?
| 3. **Configuration File**: | ||
|
|
||
| - The agent also requires a YAML configuration file. The path to this file must be specified in the `.env` file via `EBO_AGENT_CONFIG_FILE_PATH`. | ||
| - To set up the configuration, copy `config.example.yml` to `config.yml`: |
will do this in my next README pr today 👍🏻 |
🤖 Linear
Closes GRT-221
Description
Questions