Update README #76
Merged
Update README #76
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
ines-toupeira
commented
Dec 5, 2024
ines-toupeira
commented
- clarification of the purpose of the validators-api
- improvement on the overall README and JSON schema
- clarification of the purpose of the validators-api - improvement on the JSON schema specifications
Deploying validators-api-mainnet with
|
| Latest commit: |
45af544
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://3d16fe3c.validators-api-mainnet.pages.dev |
| Branch Preview URL: | https://update-guidelines.validators-api-mainnet.pages.dev |
Deploying validators-api-testnet with
|
| Latest commit: |
45af544
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://5a694e7e.validators-api-testnet.pages.dev |
| Branch Preview URL: | https://update-guidelines.validators-api-testnet.pages.dev |
onmax
requested changes
Dec 5, 2024
README.md
Outdated
| - Use the provided example template in the directory to structure your data. | ||
| 3. Review the [Description Guidelines](#recommendations-for-your-validator-information). | ||
| 4. Learn about the [JSON Schema](#validator-json-schema). | ||
| 5. Submit a PR to this repository. A Nimiq team member will review your submission. |
There was a problem hiding this comment.
At the moment this process is quite opaque and slow (up to 3 days).
Can we add something about this? We need to be more transparent:
- Why it takes so much?
- What are we verifying exactly?
- We need to verify the website contents
- We need to verify that the fee stated by the validator is what actually is doing (not sure how this is being tested, ask Micha)...
Not sure if this is the place
There was a problem hiding this comment.
I talked to Micha and Richy. The PR will be reviewed in up to 3 days; fee verification is an ongoing process. In this README, I will only mention it in the PR verification. The fee verification time will be updated in the pool guidelines
README.md
Outdated
| - `name`: The name of your validator. If you don’t provide a name, your validator address will be used by default. | ||
| - `description`: A short description of your validator. Use this to highlight what makes your validator unique or appealing to stakers. | ||
| - `address`: The address of the validator in this format `NQXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX XXXX`. | ||
| - `fee`: A percentage fee between 0 and 1 (0.05 represents a 5% fee). |
There was a problem hiding this comment.
Not sure if this is clear enough 🙈 .
Maybe overthinking, but something like this might be clearer?
- Fee information. You need to add ONE of the following:
- For static fees, use `fee`. A percentage fee between 0 and 1 (0.05 represents a 5% fee).
- For dynamic fees, you need to add three keys:
- `feeLowest`: The minimum possible fee.
- `feeHighest`: The maximum possible fee.
- `feeDescription`: Outline the conditions for various fees.
onmax
requested changes
Dec 5, 2024
commit: |
Albermonte
requested changes
Dec 6, 2024
|
@onmax I don't think we should include other file changes except the readme and the |
I know. I was looking how we can detach the commits I made from this PR but not sure how I can do it... |
ines-toupeira
force-pushed
the
update-guidelines
branch
from
5dd77a3 to
5f2bbea
Compare
onmax
reviewed
Dec 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.