Update instructions for running from source + docker

[eelanagaraj]

First pass at updating the README -- still needs some work, but most of the very out-of-date sections have been removed and the instructions for running from source/docker have been updated and should run as expected.

[barbaraliau]

Looks good! See comments.

[barbaraliau]

submitting some comments while i go through the rest of the PR

[barbaraliau]

more comments

[barbaraliau]

I've tested almost everything and it looks like everything is g2g except I was getting build errors in the celo-monorepo for rc1. I'm going to assume that everything would work as expected though.

Actually, would this just be running on mainnet instead? Was the rc1 branch written before the launch of mainnet? If. so, then would any rc1 references need to be updated to mainnet/master?

[barbaraliau]

I had to run ./bin/rosetta-cli check:construction ... to get this to run (from the directory I installed it), so recommending installing rosetta-cli into /usr/local/bin instead of where the command is run would be better. as well as adding instructions to update the command to point to the right path for the cli-config.json file

• Install rosetta-cli

If on Mac, it is recommended to install rosetta-cli into /usr/local/bin

curl -sSfL https://raw.githubusercontent.com/coinbase/rosetta-cli/master/scripts/install.sh | sh -s -- -b /usr/local/bin

[eelanagaraj]

I'm hesitant to add the actual install instructions for the cli here since that'll be an additional piece that we need to ensure is kept up to date (with the rosetta-cli README), so I'd prefer deferring to their installation instructions for that reason. That said, I'll add a note that installing to /usr/local/bin will allow you to use rosetta-cli directly on the command line (without the path to it)

[barbaraliau]

I'm actually not sure if I can run checks becaus eI just get a bunch of these

2021/01/28 14:48:08 waiting for implementation to reach tip before testing...
[MEMORY] Heap: 1103.278084MB Stack: 0.687500MB System: 1260.756973MB GCs: 5
[STATS] Transactions Confirmed: 0 (Created: 0, In Progress: 0, Stale: 0, Failed: 0) Addresses Created: 0
2021/01/28 14:48:18 waiting for implementation to reach tip before testing...

How long does it normally take before it reaches the tip? Should I leave it running for a while? If so, I'd add something about that

[eelanagaraj]

Yes you're all good! It depends on whether you're starting with a fresh node or one with data, etc. Will add a note about that, but yes if this is the first time it'll take quite a while to reach the tip (syncing a full archive node). Data Checks themselves will take a long time since it needs to go through the entire chain + reconcile balances.

[eelanagaraj]

✅ added a note about this

[barbaraliau]

Oh but also either way I think these instructions can be merged with what is here and any other changes can be done in a different PR if you want. I'll leave it up to you to decide.

[eelanagaraj]

I've tested almost everything and it looks like everything is g2g except I was getting build errors in the celo-monorepo for rc1. I'm going to assume that everything would work as expected though.

Actually, would this just be running on mainnet instead? Was the rc1 branch written before the launch of mainnet? If. so, then would any rc1 references need to be updated to mainnet/master?

@barbaraliau I believe mainnet == rc1. That said, for monorepo, this part is actually a bit more lax for now, as it should only affect the generated contract wrappers (and since there haven't been any relevant breaking changes, it should also even be fine to build a later version of master as long as it's pre-breaking changes). (This is something we'll have to address anyways when dealing with contract upgrades, but i'd suggest we punt it until that comes)

[eelanagaraj]

@barbaraliau addressed your comments, I think it makes sense to push so it'll be easier to maintain + make sure it doesn't get out of date + need to be updated again. In the future, we can also add troubleshooting sections and such, esp. once we see what usage is like of the package. Thanks for your comments!