Skip to content
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

Add a "technical specs" page. Fixes #780 #894

Merged
merged 4 commits into from Nov 11, 2020
Merged

Add a "technical specs" page. Fixes #780 #894

merged 4 commits into from Nov 11, 2020

Conversation

diwakergupta
Copy link
Member

No description provided.

@vercel
Copy link

vercel bot commented Nov 8, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/blockstack/blockstack-docs/patw2ifa8
✅ Preview: https://blockstack-docs-git-feat-780.blockstack.vercel.app

@github-actions
Copy link

github-actions bot commented Nov 8, 2020

Blockstack Documentation

Blockstack docs have been deployed with Vercel using the code from this PR!

📝 Changed routes:

…kchain/technical-specs
Screenshot of /stacks-blockchain/technical-specs
(view full size)

Built with commit aa67079.

@diwakergupta
Copy link
Member Author

@agraebe @jeffdomke before I spend more time on this, want to get your quick take on whether this is directionally correct -- does this address what you in mind?

@agraebe
Copy link
Contributor

agraebe commented Nov 9, 2020

looks great - this is what I had in mind

@diwakergupta diwakergupta changed the title First draft of a "technical specs" page for Stacks 2.0 Add a "technical specs" page. Fixes #780 Nov 10, 2020
@diwakergupta diwakergupta marked this pull request as ready for review November 10, 2020 03:25
Copy link
Contributor

@agraebe agraebe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is awesome, left some comments for smaller improvements


## Stacking

- Stacking works in 2 phases
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we mention that stacking is essentially a clarity contract & maybe linking to the stacking contract references would make sense?

src/pages/stacks-blockchain/technical-specs.md Outdated Show resolved Hide resolved
3. _sending account_ is the account that identifies who is currently executing the transaction: this can change as a transaction executes via the `as-contract` Clarity function
- Two types of authorizations: standard authorization is where originating account is the same as paying account. _Sponsored_ authorization is where originating account and paying account are distinct. For instance, developers or service providers could pay for users to call their smart-contracts.
- For sponsored authorization, first a user signs with the originating account and then a sponsor signs with the paying account.
- Transaction encoding is described [here](https://github.com/blockstack/stacks-blockchain/blob/master/sip/sip-005-blocks-and-transactions.md#transaction-encoding).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why? This bullet is about encoding, not delegation

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- Two types of authorizations: standard authorization is where originating account is the same as paying account. _Sponsored_ authorization is where originating account and paying account are distinct. For instance, developers or service providers could pay for users to call their smart-contracts.
- For sponsored authorization, first a user signs with the originating account and then a sponsor signs with the paying account.
- Transaction encoding is described [here](https://github.com/blockstack/stacks-blockchain/blob/master/sip/sip-005-blocks-and-transactions.md#transaction-encoding).
- Transaction signing and verification are described [here](https://github.com/blockstack/stacks-blockchain/blob/master/sip/sip-005-blocks-and-transactions.md#transaction-signing-and-verifying).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

@diwakergupta diwakergupta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updating PR with many suggested changes.

src/common/navigation.yaml Show resolved Hide resolved
3. _sending account_ is the account that identifies who is currently executing the transaction: this can change as a transaction executes via the `as-contract` Clarity function
- Two types of authorizations: standard authorization is where originating account is the same as paying account. _Sponsored_ authorization is where originating account and paying account are distinct. For instance, developers or service providers could pay for users to call their smart-contracts.
- For sponsored authorization, first a user signs with the originating account and then a sponsor signs with the paying account.
- Transaction encoding is described [here](https://github.com/blockstack/stacks-blockchain/blob/master/sip/sip-005-blocks-and-transactions.md#transaction-encoding).
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why? This bullet is about encoding, not delegation

Mostly adding links.
Copy link
Contributor

@agraebe agraebe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left one note, but looking great overall! approving so we can merge once ready

Thanks @diwakergupta 🙏

@GinaAbrams
Copy link
Member

hey @agraebe would you be able to please link to this new page here when you have a moment? 🙏 sorry I should be able to find, not discovering here.

@diwakergupta
Copy link
Member Author

hey @agraebe would you be able to please link to this new page here when you have a moment? 🙏 sorry I should be able to find, not discovering here.

@GinaAbrams here you go: https://docs.blockstack.org/stacks-blockchain/technical-specs

@GinaAbrams
Copy link
Member

Woot thanks @diwakergupta!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Stacks integration guide: Add reference page to list key properties of Stacks 2.0
3 participants