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.
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Initial sbtc docs update #1647
base: master
Are you sure you want to change the base?
Initial sbtc docs update #1647
Changes from 23 commits
80ac988
5e8dd87
83a6bf5
0471ed2
fccd5e5
3d7dda0
0855f19
33afe59
3a017c6
3cda94e
09e394f
4ac29b6
ef10c0d
1e74769
b1e2b80
6d39eae
492d219
6cbcaa8
2dd4af9
d18b13e
c875227
4fb1764
3796d5a
ff3cbd3
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
Large diffs are not rendered by default.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This has been mentioned a few times now that i've noticed, but i don't see how a "BTC holder" may participate in DeFi. If we're not going to say how someone can do that in this doc, i would reword this. I don't have any suggestions at the moment though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can this be quantified? i.e.
... within 5 bitcoin blocks
or whichever is the correct number of blocksThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i would be specific here and mention there will be 15 signers, and possibly link to the SIP defining how those signers shall be chosen (or the working group discussion where the initial signers are listed)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above - i'm not sure how accurate/informative needs to be, but it feels like these statements are missing context and introduce questions that aren't being answered.
the counter argument is that it's not relevant for the doc, and would just add more text to read through vs being shorter and easier to digest.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: this needs segue into what the concepts are.
either a numbered or bullet list, or simply a colon or something at the end of the sentence.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: link to sip-010
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a little nebulous - will they communicate with any contract, or just the sbtc contracts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't know if this is true - the initial set of signers was not chosen through a vote, only the criteria of how they were selected (and no vote has taken place as of yet)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we link to teh github repo or other API docs? I'd like to know more about this API
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: add link to the ratified SIP
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this claim needs more context - can we link to a SIP or repo/docs that define how this occurs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is a bit unclear - does a key rotation need a vote from the full community, or is it a smaller vote (i.e. the signers themselves call a vote with the other signers)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: link to sip-010
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we have contracts we can link to? i imagine that there will be a repo with this contracts since they're not deployed yet
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same comment applies to all mentions later of
xxx-contract.clar
- would be great have them link to the actual contract