Rearrange functions to avoid circular dependency #2082
Conversation
|
|
||
| In order for users to request attestations from your service, you need to register the endpoint under which your service is reachable in your [metadata](/celo-codebase/protocol/identity/metadata). Run the following commands on your local machine where `$CELO_VALIDATOR_ADDRESS` is unlocked. | ||
| We are using [Metadata](/celo-codebase/protocol/identity/metadata) to allow accounts to make certain claims without having to do so on-chain. For us to complete the process, we have to make two claims: |
There was a problem hiding this comment.
best to use a relative URL here so it'll work if there's a different tree (e.g master vs alfajores) and for folks browsing github too
|
|
||
| ```bash | ||
| # On your local machine | ||
| celocli account:create-metadata ./metadata.json --from $CELO_VALIDATOR_ADDRESS | ||
| celocli account:create-metadata ./metadata.json --from 0x$CELO_VALIDATOR_ADDRESS |
There was a problem hiding this comment.
ugh - can't we just add 0x if it's not already present?
There was a problem hiding this comment.
We can, but this is I believe the short term fix we have been applying everywhere
There was a problem hiding this comment.
I also think we should really streamline, i personally would prefer us to 0x everywhere
| ``` | ||
|
|
||
| The `ATTESTATION_SERVICE_URL` variable stores the URL to access the Attestation Service deployed. In the following command we specify the URL where this Attestation Service is: | ||
|
|
||
| ```bash | ||
| # On your local machine | ||
| celocli account:claim-attestation-service-url ./metadata.json --url $ATTESTATION_SERVICE_URL --from $CELO_VALIDATOR_ADDRESS | ||
| celocli account:claim-attestation-service-url ./metadata.json --url $ATTESTATION_SERVICE_URL --from 0x$CELO_VALIDATOR_ADDRESS |
|
|
||
| ```bash | ||
| # On your local machine | ||
| celocli account:claim-account ./metadata.json --address 0x$CELO_VALIDATOR_GROUP_ADDRESS --from 0x$CELO_VALIDATOR_ADDRESS |
| @@ -590,7 +602,7 @@ And then host your metadata somewhere reachable via HTTP. You can use a service | |||
| celocli account:register-metadata --url <METADATA_URL> --from $CELO_VALIDATOR_ADDRESS | |||
| ``` | |||
|
|
|||
| If everything goes well users should see that you are ready for attestations by running: | |||
| If everything goes well users should be able to see your claims by by running: | |||
|
minor things |
|
I'd vote to punt the |
|
Looks like you need to rebuild docs |
Codecov Report
@@ Coverage Diff @@
## master #2082 +/- ##
=======================================
Coverage 74.42% 74.42%
=======================================
Files 281 281
Lines 7824 7824
Branches 975 975
=======================================
Hits 5823 5823
Misses 1884 1884
Partials 117 117
Continue to review full report at Codecov.
|
Description
This PR removes a circular dependency and amends the documentation to highlight the need to register a validator's metadata with the appropriate claims in them.