Skip to content

Commit

Permalink
docs: refine README
Browse files Browse the repository at this point in the history
still TODO: screenshots
  • Loading branch information
dckc committed Nov 12, 2023
1 parent ad25368 commit 5ef3209
Showing 1 changed file with 42 additions and 11 deletions.
53 changes: 42 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,21 @@ On top of that, we add
- Watching [blockchain state queries](https://docs.agoric.com/guides/getting-started/contract-rpc.html#querying-vstorage)
- [Signing and sending offers](https://docs.agoric.com/guides/getting-started/contract-rpc.html#signing-and-broadcasting-offers)

## Getting started: UI
## Getting started: test the contract

Prerequisites: `node`, `yarn`
Prerequisites: `agoric` CLI from [Installing the Agoric SDK](https://docs.agoric.com/guides/getting-started/).

```sh
agoric --version
agoric install
cd contract
yarn
yarn dev
yarn test
```

## Getting started: Deploy to Local Blockchain

Prerequisites: [Agoric SDK](https://docs.agoric.com/guides/getting-started/), `docker-compose`.

Build the contract and a proposal to start it:

```sh
yarn build:contract
yarn build:proposal
```
Prerequisites: `docker-compose`, [gov proposal hub](https://github.com/0xpatrickdev/agoric-gov-proposal-hub).

Start local chain using docker-compose:

Expand All @@ -53,3 +49,38 @@ To explore in the container where the node runs:
yarn docker:bash
agd query vstorage children published.priceFeed
```

Build the proposal to start the contract:

```sh
cd contract
yarn build:proposal
```

The filenames of bundles, a permit, and a script are printed.

Use the **Install Bundle** tab of the gov proposal hub to install the
2 bundles. Get ready to vote with `yarn docker:make vote PROPOSAL=n`.
Use the **CoreEval Proposal** tab to propose `start-game1-permit.json`
and `start-game1.js`. Note the proposal number; supposing it is 7, use
`yarn docker:make vote PROPOSAL=7`. Note the voting period is very
short! 10s by default.

## Buy some game places with the dapp UI

Prerequisites: `node`, `yarn`, keplr.

```sh
cd ui
yarn
yarn dev
```

Use `docker:bash` command to print account info, including `user1`.
Add that account to keplr.

Then hit **Connect Wallet**. The UI should show your address.

Then **Make Offer**. Keplr should show an offer to **give** 0.25 IST
and **want** a few places. Sign and broadcast the offer.
After a few seconds, the UI should show the places.

0 comments on commit 5ef3209

Please sign in to comment.