Validator UX docs for baklava network #1688
Conversation
Codecov Report
@@ Coverage Diff @@
## asaj/aaitor-docs #1688 +/- ##
=================================================
Coverage 74.2% 74.2%
=================================================
Files 278 278
Lines 7653 7653
Branches 956 672 -284
=================================================
Hits 5679 5679
Misses 1857 1857
Partials 117 117
Continue to review full report at Codecov.
|
…o-monorepo into feature/baklava_validator_doc
|
This PR shouldn't be merged till the official baklava images are publicly available and all the commands are tested again using those images. |
…o-monorepo into feature/baklava_validator_doc
…o-monorepo into feature/baklava_validator_doc
…o-monorepo into feature/baklava_validator_doc
…o-monorepo into feature/baklava_validator_doc
Needs to be tested with a publicly available attestation-service docker image as soon as this as published.
aaitor
changed the title
| @@ -19,6 +19,7 @@ | |||
| "prepublishOnly": "yarn build:gen && yarn build", | |||
| "start-ts": "TS_NODE_FILES=true ts-node src/index.ts", | |||
| "start": "node lib/index.js", | |||
| "db:create": "mkdir -p db && touch db/dev.db", | |||
There was a problem hiding this comment.
I don't think this should be here? I.e. it should not be the concern of this application to create databases other than for development and testing
There was a problem hiding this comment.
that command was to make it consistent with the documentation found in the README.md of the attestation-service and the comment made about not including the dev suffix.
What do you suggest? Add the command or keep the yarn run db:create:dev instruction in the README?
| docker pull $CELO_IMAGE | ||
| ``` | ||
|
|
||
| ### Create accounts |
There was a problem hiding this comment.
IMO this section should cover the creation of the attestation key
There was a problem hiding this comment.
To avoid duplicate this documentation in two pages, I added the text clarifying are necessary 4 accounts (Validator, Validator Group, Proxy and Attestation Service) and added a link to the attestation service documentation page.
| | DATABASE_URL | The URL under which your database is accessible, currently supported are `postgres://`, `mysql://` and `sqlite://` | | | ||
| | CELO_PROVIDER | The URL under which a celo blockchain node is reachable, i.e. something like `https://integration-forno.celo-testnet.org` | | | ||
| | ACCOUNT_ADDRESS | The address of the validator account | | | ||
| | ATTESTATION_KEY | The private key with which attestations should be signed. You could use your account key for attestations, but really you should authorize a dedicated attestation key | | |
There was a problem hiding this comment.
We should probably just tell people to delegate an attestation signer, it's actually quite hard to retrieve the account key for use anyways
| celocli account:new | ||
| ``` | ||
|
|
||
| We copy the account details and assign the Private Key to the `ATTESTATION_KEY` environment variable: |
There was a problem hiding this comment.
We need to authorize the key on the Accounts smart contract
| You can find the migration scripts for creating the schema at the `celo-monorepo`, `packages/attestation-service` folder. From there, after setting up the `DATABASE_URL` env variable you can run the following commands: | ||
|
|
||
| ```bash | ||
| yarn run db:create |
There was a problem hiding this comment.
This won't work other than the sqlite driver
There was a problem hiding this comment.
removing that db:create line and adding reference that depending on the database technology the users need to create the database with the proper user access.
* master: (61 commits) [Wallet] Handle `/v/<code` deep links for phone verifications (#1776) Patch tslint auto fix for macOS Catalina until tslint#6.x is out (#1802) Fix typos (#1855) Update documentation sidebar (#1861) [Wallet] Update forno dev documentation (#1818) [Docs] Correct typo Validator UX docs for baklava network (#1688) (#1849) Various improvements to the CLI, allow voters to revote for a group (#1840) Serialize to hex string (#1848) Update faucet to pull from the reserve when possible (#1844) Fix elect validators migration, deploy integration (#1847) Configurable genesis balances (#1838) Deploy new version of Celostats and minnor change from celo-blockchain (#1714) Make default node URL consistent in celocli (#1805) Onboarding feedback (#1811) return at least true, when the function is returning bool (#1825) Minor Contractkit changes (#1819) Point end-to-end tests back to master (#1824) Update migration config to correct protocol parameters (#1822) Update with new istanbul lookback window size flag (#1820) ... # Conflicts: # yarn.lock
Description
As a validator I expected to have a valid documentation page allowing to me to run a validator in
baklavanetwork including the validator, proxy and attestation service.Tested
An explanation of how the changes were tested or an explanation as to why they don't need to be.
Other changes
Describe any minor or "drive-by" changes here.
Related issues
Backwards compatibility
Brief explanation of why these changes are/are not backwards compatible.