Skip to content

Commit 8f3b65a

Browse files
committed
docs: skeletal orchestration contract package
1 parent 890fe52 commit 8f3b65a

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

packages/orch-skel/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# orch-skel - skeletal orchestration contract package
2+
3+
To develop an orchestration contract:
4+
0. copy this package to a new directory; change the name (and description) in `package.json`
5+
1. make a rough sequence diagram - `test/my-orch-sequence.mmd`
6+
2. refine the sequence diagram to `@agoric/orchestration` objects and messages
7+
3. prototype each of the objects in the sequence diagram and make a test to exercise them - `test/my-orch-seq-sim.test.ts`
8+
4. refine the prototype into a contract (`src/my.contract.ts`) with flows (`my.flows.ts`) and make a test for it (`test/my-orch-contract.test.ts`)
9+
10+
## Install Dependencies
11+
12+
```
13+
yarn install
14+
```
15+
16+
## Run Static Checks
17+
18+
```console
19+
yarn lint
20+
```
21+
22+
## Run Tests
23+
24+
```console
25+
yarn test
26+
```
27+
28+
Don't be surprised by `Error#2: TODO!`: the contract and flows are incomplete.

0 commit comments

Comments
 (0)