add example to staking pool factory 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
Comment on lines
+67
to
+72
| Contract initialization: | ||
| ```bash | ||
| near call <staking_pool_factory> new '{"staking_pool_whitelist_account_id": <whitelist_contract>}' | ||
| ``` | ||
| where `<whitelist_contract>` it the account id of the whitelist contract that this factory | ||
| is associated with. |
There was a problem hiding this comment.
I think this should be inlined with the deployment, but it's okay to have it as an initialization example with the note of caution.
Comment on lines
+74
to
+78
| Staking pool creation: | ||
| ```bash | ||
| near call <staking_pool_factory> create_staking_pool '{"staking_pool_id": <staking_pool_id>, "owner_id": <owner_id>, "stake_public_key": <stake_public_key>, "reward_fee_fraction": <reward_fraction>}' | ||
| ``` | ||
| Here `reward_fee_fraction` is an object like `{"numerator": 10, "denominator": 100}`. |
There was a problem hiding this comment.
Please explain every parameter, because people are still confused. Or point to the staking-pool contract
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.
Add example usage of the staking pool factory.