Skip to content

Commit

Permalink
update zoe overview to match dapp-offer-up; add contract basics (#889)
Browse files Browse the repository at this point in the history
* test(zoe): snippets for learning zoe lessons 1, 2, 3

* docs: contract basics: hello, testing, state, access control

 - don't show region comments
 - reference to Zoe is just a distraction
 - index start later
 - fix test name
 - don't mention snippets
 - connect to surrounding sections
 - link fixes

* docs(zoe): markdown lint

* docs(sidebar): begin reorg: Zoe comes after Getting Started, etc.

* chore: update sidebar for contract-basics

* docs: distinguish Zoe from the framework

* chore: copy gameAssetContract, test-alice from dapp-game-places

 - debug.js too
 - refactor(test-alice-trade): rename pmt to Place
   to match keyword, resulting in short property form
   that's handy in a diagram
 - refactor: postpone discussion of harden
   returning a fresh { ... } record does not put a function at
   risk.
 - hide region markers in full listing
   add whole-file region to suppress others

* build: ERTP

* test: test-bundle-source.js with regions

* docs(zoe): Bundling, Installation, Starting w/basic dapp

sections that are starting to take shape:

 - Bundling a Contract
   Get this housekeeping aspect out of the way
   so that further tests can ignore it.
 - Contract Installation
 - Starting a contract

* docs: Trading with Offer Safety

* docs(zoe): prune material covered by current approach

 - rescue a few bits

* docs(zoe): sequence diagrams for Trading with Offer Safety section

* chore: generated SVG sequence diagrams for zoe section

* docs(zoe): full contract listing; misc. clarification

 - make each section more context-free by harking
   back explicitly to the basic dapp
 - focus on lines by number
 - misc. editorial

* docs(zoe): add diagrams to Trading with Offer Safety section

* refactor(coreeval): Contract Installation section was renamed

* docs(zoe): include Instance in starting heading

* fixup! docs(zoe): Bundling, Installation, Starting w/basic dapp

* fixup! docs: Trading with Offer Safety

* docs: editorial: avoid "a contract _is_ a module..."

* fixup! chore: update sidebar for contract-basics

* docs(zoe): editorial

Co-authored-by: Chris Hibbert <[email protected]>

* fixup! docs(zoe): Bundling, Installation, Starting w/basic dapp

* fixup! docs(zoe): Bundling, Installation, Starting w/basic dapp

* fixup! test(zoe): snippets for learning zoe lessons 1, 2, 3

* fixup! chore: copy gameAssetContract, test-alice from dapp-game-places

* WIP: ava unresolved work-around

* fixup: alice-trade is not a test file

* Update main/guides/zoe/README.md

Co-authored-by: Chris Hibbert <[email protected]>

---------

Co-authored-by: Chris Hibbert <[email protected]>
  • Loading branch information
dckc and Chris-Hibbert authored Jan 9, 2024
1 parent 47b86cf commit 85146a3
Show file tree
Hide file tree
Showing 23 changed files with 732 additions and 200 deletions.
29 changes: 16 additions & 13 deletions main/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,20 @@ module.exports = {
'/guides/getting-started/syncing-up.html',
],
},
{
title: 'Zoe',
path: '/guides/zoe/',
collapsible: false,
children: [
'/guides/zoe/contract-basics.html',
'/guides/zoe/',
'/guides/zoe/offer-enforcement.html',
'/guides/zoe/offer-safety.html',
'/guides/zoe/proposal.html',
'/guides/zoe/contract-requirements.html',
'/guides/zoe/price-authority.html',
],
},
{
title: 'Agoric CLI',
path: '/guides/agoric-cli/',
Expand Down Expand Up @@ -214,19 +228,6 @@ module.exports = {
'/guides/ertp/purses-and-payments.html',
],
},
{
title: 'Zoe',
path: '/guides/zoe/',
collapsible: false,
children: [
'/guides/zoe/',
'/guides/zoe/offer-enforcement.html',
'/guides/zoe/offer-safety.html',
'/guides/zoe/proposal.html',
'/guides/zoe/contract-requirements.html',
'/guides/zoe/price-authority.html',
],
},
{
title: 'Permissioned Contract Deployment',
path: '/guides/coreeval/',
Expand Down Expand Up @@ -281,6 +282,8 @@ module.exports = {
'/guides/dapps/',
'/guides/dapps/dapp-templates.html',
'/guides/dapps/starting-multiuser-dapps.html',
'/guides/getting-started/deploying.html',
'/guides/getting-started/contract-rpc.html',
],
},
{
Expand Down
5 changes: 1 addition & 4 deletions main/guides/coreeval/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Permissioned Contract Deployment

Until mainnet enters the Mainnet-3 phase of the [multi-phase mainnet rollout](https://agoric.com/blog/announcements/mainnet-phase-0-launch),
permissionless [contract installation with Zoe](/guides/zoe/#writing-and-installing-a-contract)
permissionless [contract installation with Zoe](/guides/zoe/#contract-installation)
is limited to development environments.

Until then, permission to deploy contracts can be granted using an Agoric extension to [Cosmos SDK Governance](https://hub.cosmos.network/main/delegators/delegator-guide-cli.html#participating-in-governance) called `swingset.CoreEval`. As discussed in [governance using Hardened JavaScript: swingset\.CoreEval](https://community.agoric.com/t/bld-staker-governance-using-hardened-javascript-swingset-coreeval/99),
Expand All @@ -12,6 +12,3 @@ To do try it out in a local testnet chain:
1. [Declare the capabilities that the proposal will require](./permissions.md).
2. [Code the proposal itself](./proposal.md).
3. [Deploy the proposal to a local testnet](./local-testnet.md).



Loading

0 comments on commit 85146a3

Please sign in to comment.