docs: prose overview for the interaction diagram for Zoe and Zcf #1348
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
Includes security claims about the split, as well as description of how Zoe and Zcf communicate while making new instances of contracts.
katelynsills
approved these changes
Jul 30, 2020
packages/zoe/docs/zoe-zcf.md
Outdated
| @@ -0,0 +1,57 @@ | |||
| ## Zoe and ZCF | |||
|
|
|||
| At the current time, Zoe is split into an "upper" part, which is the facet that the contract communicates with, and the "middle", which contains all the common pieces shared across all contracts. The middle has the InviteIssuer, manages the purses for all contract instances, and is the central point of contact for installing and instantiating contracts. Each time a contract is instantiated with makeInstance(), a new vat is created, and the code for ZCF (the Zoe Contract Facet) is executed, immediately running the code for the contract itself. | |||
There was a problem hiding this comment.
Let's not use upper and middle
There was a problem hiding this comment.
okay. I didn't find consensus terminology for zoe main, so I made something up.
packages/zoe/docs/zoe-zcf.md
Outdated
|
|
||
| Zoe has a single InviteMint, which it uses to mint Invitations which verify the authenticity of contracts and seats. Zoe freely shares the corresponding Issuer, so everyone can recognize valid Invitatations. | ||
|
|
||
| Zoe is created with SwingSet. Any user can call `E(zoe).install(bundle)` to create a new verified installation of a contract. From that point, anyone can validate the source code, or get assurances from Zoe that a particular instance of that contract is running that code. |
There was a problem hiding this comment.
Suggested change
| Zoe is created with SwingSet. Any user can call `E(zoe).install(bundle)` to create a new verified installation of a contract. From that point, anyone can validate the source code, or get assurances from Zoe that a particular instance of that contract is running that code. | |
| Zoe is created by CosmicSwingset. Any user can call `E(zoe).install(bundle)` to create a new installation of a contract. From that point, anyone can use the installation to view the code and to get assurances from Zoe that a particular instance of that contract is running that code. |
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.
Includes security claims about the split, as well as description of
how Zoe and Zcf communicate while making new instances of contracts.
#1288
#553