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 with Filecoin mainnet, remove ETH Goerli #593

Merged
merged 2 commits into from
Jul 12, 2023

Conversation

dtbuchholz
Copy link
Contributor

Summary

Mentions of Filecoin Mainnet being unsupported have been removed. There was also a mention of an ETH Goerli heltbot table instead of Sepolia.

Context

N/A

Implementation overview

N/A

Implementation details and review orientation

N/A

Checklist

  • Are changes backward compatible with existing SDKs, or is there a plan to manage it correctly?
  • Are changes covered by existing tests, or were new tests included?
  • Are code changes optimized for future code readers, commenting on problematic areas to understand (if any)?
  • Future-self question: Did you avoid unjustified/unnecessary complexity to achieve the goal?

Mentions of Filecoin Mainnet being unsupported have been removed. There was alos a mention of an ETH Goerli API key instead of Sepolia.
@dtbuchholz
Copy link
Contributor Author

Note: it looks like staging doesn't have all of the changes currently in main, so I'm pointing to main here. Lmk if I should adjust that.

```

> Note: there is also an optional `METRICS_HUB_API_KEY` variable; this can be left empty. It's a service (`cmd/metricshub`) that aggregates metrics like `git summary` and pushes them to centralized infrastructure ([GCP Cloud Run](https://cloud.google.com/run)) managed by the core team. If you'd like to have your validator push metrics to this hub, please reach out to the Tableland team, and we may make it available to you. However, this process will further be decentralized in the future and remove this dependency entirely. Additionally, if you'd like to run a validator for the Filecoin Calibration testnet, use the `VALIDATOR_GLIF_FILECOIN_CALIBRATION_API_KEY` key with an empty value, placed in the `docker/deployed/testnet` config since it allows for unauthenticated requests.
> Note: there is also an optional `METRICS_HUB_API_KEY` variable; this can be left empty. It's a service (`cmd/metricshub`) that aggregates metrics like `git summary` and pushes them to centralized infrastructure ([GCP Cloud Run](https://cloud.google.com/run)) managed by the core team. If you'd like to have your validator push metrics to this hub, please reach out to the Tableland team, and we may make it available to you. However, this process will further be decentralized in the future and remove this dependency entirely.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part about having an empty key for calibration testnet still holds, so there is no need to delete it? For the mainnet we have a different key at VALIDATOR_GLIF_FILECOIN_MAINNET_API_KEY=

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

umm so the main reason i had it there originally was because the .env variables above that section didn't make any mention of FIL mainnet since we didn't support it, yet. so, i had wanted to provide clarity on what was needed in the testets setup since it, basically, replicates what's described for mainnets.

now that we have a mainnet FIL variable there, i think it's probably fine to drop the mention. plus, the .env example has the proper key for testnet-only support.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay, sounds good 👍

@@ -343,7 +344,7 @@ This would result in having four tables—one per chain:
You should create a file `.env_healthbot` in the `docker/deployed/testnet/healthbot` folder with the following content (an example is provided with `.env_healthbot.example`):

```txt
HEALTHBOT_ETHEREUM_GOERLI_TABLE=healthbot_5_{tableID}
HEALTHBOT_ETHEREUM_SEPOLIA_TABLE=healthbot_11155111_{tableID}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@@ -183,9 +183,10 @@ You must configure each EVM account's private keys and EVM node provider API key
VALIDATOR_ALCHEMY_ARBITRUM_MAINNET_API_KEY=<your arbitrum mainnet alchemy key>
VALIDATOR_ALCHEMY_POLYGON_MAINNET_API_KEY=<your polygon mainnet alchemy key>
VALIDATOR_QUICKNODE_ARBITRUM_NOVA_MAINNET_API_KEY=<your arbitrum nova mainnet quicknode key>
VALIDATOR_GLIF_FILECOIN_MAINNET_API_KEY=
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@avichalp
Copy link
Collaborator

@dtbuchholz: looks good!, i have one small question. its seems okay to merge directly in the main after the staging is merged since it is a small change in the docs imo

@dtbuchholz
Copy link
Contributor Author

cool, sgtm. i can wait til that happens and then merge this to main

@avichalp avichalp merged commit 7fa3650 into main Jul 12, 2023
@avichalp avichalp deleted the dtb/update-readme-filecoin branch July 12, 2023 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants