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

update zoe overview to match dapp-offer-up; add contract basics #889

Merged
merged 32 commits into from
Jan 9, 2024
Merged
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
7003b66
test(zoe): snippets for learning zoe lessons 1, 2, 3
dckc Nov 29, 2023
eb25aac
docs: contract basics: hello, testing, state, access control
dckc Nov 29, 2023
4ca123e
docs(zoe): markdown lint
dckc Dec 6, 2023
68f631a
docs(sidebar): begin reorg: Zoe comes after Getting Started, etc.
dckc Dec 6, 2023
ddcf19c
chore: update sidebar for contract-basics
dckc Dec 8, 2023
1291598
docs: distinguish Zoe from the framework
dckc Dec 6, 2023
36db0b5
chore: copy gameAssetContract, test-alice from dapp-game-places
dckc Dec 7, 2023
d58b5ce
build: ERTP
dckc Dec 8, 2023
4aa44ec
test: test-bundle-source.js with regions
dckc Dec 6, 2023
7901a07
docs(zoe): Bundling, Installation, Starting w/basic dapp
dckc Dec 6, 2023
70b3fc2
docs: Trading with Offer Safety
dckc Dec 7, 2023
a2b4063
docs(zoe): prune material covered by current approach
dckc Dec 7, 2023
bdcb38d
docs(zoe): sequence diagrams for Trading with Offer Safety section
dckc Dec 7, 2023
558d49e
chore: generated SVG sequence diagrams for zoe section
dckc Dec 7, 2023
5f93deb
docs(zoe): full contract listing; misc. clarification
dckc Dec 7, 2023
e1c2948
docs(zoe): add diagrams to Trading with Offer Safety section
dckc Dec 7, 2023
d825818
refactor(coreeval): Contract Installation section was renamed
dckc Dec 7, 2023
290f312
docs(zoe): include Instance in starting heading
dckc Dec 7, 2023
1eb3eef
fixup! docs(zoe): Bundling, Installation, Starting w/basic dapp
dckc Dec 8, 2023
9848d03
fixup! docs: Trading with Offer Safety
dckc Dec 8, 2023
6d6bb40
docs: editorial: avoid "a contract _is_ a module..."
dckc Dec 12, 2023
3f05ce6
fixup! chore: update sidebar for contract-basics
dckc Jan 3, 2024
1febd69
docs(zoe): editorial
dckc Jan 4, 2024
58e02a5
fixup! docs(zoe): Bundling, Installation, Starting w/basic dapp
dckc Jan 4, 2024
a39affa
fixup! docs(zoe): Bundling, Installation, Starting w/basic dapp
dckc Jan 9, 2024
7e8e315
fixup! test(zoe): snippets for learning zoe lessons 1, 2, 3
dckc Jan 9, 2024
955327d
fixup! chore: copy gameAssetContract, test-alice from dapp-game-places
dckc Jan 9, 2024
96cecd8
WIP: ava unresolved work-around
dckc Jan 9, 2024
3288023
fixup: alice-trade is not a test file
dckc Jan 9, 2024
5576ce1
Update main/guides/zoe/README.md
dckc Jan 9, 2024
d48ede5
refactor: clarify test imports
dckc Jan 9, 2024
1fdcda3
Merge branch 'main' into dc-contract-basic
dckc Jan 9, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs(zoe): include Instance in starting heading
dckc committed Jan 9, 2024

Verified

This commit was signed with the committer’s verified signature.
mrousavy Marc Rousavy
commit 290f31297c44ee4773f32fcea257d1dce523e77d
8 changes: 4 additions & 4 deletions main/guides/zoe/README.md
Original file line number Diff line number Diff line change
@@ -133,9 +133,9 @@ go over in detail in the sections below.

:::

## Starting a contract
## Starting a Contract Instance

Now we're ready for the to start an instance of the [basic dapp](../getting-started/) contract:
Now we're ready for the to start an _instance_ of the [basic dapp](../getting-started/) contract:

```sh
yarn ava test/test-contract.js -m 'Start the contract'
@@ -154,7 +154,7 @@ yarn ava test/test-contract.js -m 'Start the contract'

Contracts can be parameterized by _terms_.
The price of joining the game is not fixed in the source code of this contract,
but rather chosen when starting an _instance_ of the contract.
but rather chosen when starting an instance of the contract.
Likewise, when starting an instance, we can choose which asset _issuers_
the contract should use for its business:

@@ -265,7 +265,7 @@ Use [E(zoe).getTerms()](/reference/zoe-api/zoe.md#e-zoe-getterms-instance) to fi
are known to the contract.

If you're writing or instantiating the contract, you can tell the contract about issuers
when you are [creating an instance](#creating-an-instance) or by using
when you are [creating an instance](#starting-a-contract-instance) or by using
[zcf.saveIssuer()](/reference/zoe-api/zoe-contract-facet.md#zcf-saveissuer-issuer-keyword).

:::