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 #586

Merged
merged 4 commits into from
Jul 5, 2023
Merged

docs: update README #586

merged 4 commits into from
Jul 5, 2023

Conversation

dtbuchholz
Copy link
Contributor

Summary

Updated README with the latest setup steps. Closes #539.

Context

The README was outdated and inaccurate, and we had internal docs already describing the newer steps required.

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?

@dtbuchholz
Copy link
Contributor Author

dtbuchholz commented Jun 28, 2023

I referenced everything from the Notion doc with some tweaks here and there, so lmk if there's anything missing or misinterpreted!

(Note that I originally wanted to keep this README "light" and point to the docs site for much of this, but I wasn't sure how to abstract away the implementation details since all of those setup steps seemed useful.)

README.md Show resolved Hide resolved
README.md Outdated
1. Create one app for each chain using the `+ Create App` button.
2. You’ll see one row per chain—click the `View Key` button and copy/save the `API KEY`.

To get your Ankr Filecoin Keys, create an [Ankr](http://ankr.com) account, log in, and do the following:
Copy link
Collaborator

Choose a reason for hiding this comment

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

We actually stopped using Ankr because they didn't support Calibration net and we are not live with Filecoin mainnet yet. For Calibration we are using Glif.io.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@avichalp ahh, that's right. so, i can probably do 2 things:

  1. make a callout that Tableland is not live on FIL mainnet yet; this key is shown for demo purposes because when we launch, Ankr is the provider we recommend using (right? iirc, they have the archival support we need)
  2. make a callout that for FIL testnet, we use Glif.io. but, they allow for unauthenticated requests, so there's no need to set up a variable like VALIDATOR_GLIF_FILECOIN_CALIBRATION_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.

so, i think: it would be good to mention that we are not live on mainnet yet. but idk if we want to recommend Ankr yet. i would wait for them to offer the service (full archival node) we need. also, it may happen that Glif.io offers the archival node first (they plan to support it as soon as Lotus fix is ready and have offered us an API key to use it).

also, for the current configuration, we can recommend leaving the Glif API key empty: eg: VALIDATOR_GLIF_FILECOIN_CALIBRATION_API_KEY=

README.md Show resolved Hide resolved
@dtbuchholz
Copy link
Contributor Author

dtbuchholz commented Jun 30, 2023

@avichalp adjusted the README with your feedback—lmk how it looks, and then i can also duplicate this on our docs site if it's 👍

Copy link
Collaborator

@avichalp avichalp left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@dtbuchholz dtbuchholz merged commit 360d37d into main Jul 5, 2023
5 checks passed
@dtbuchholz dtbuchholz deleted the dtb/update-readme branch July 5, 2023 17:52
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.

[GOT-102] Update README
2 participants