install from npm; smart-wallet / local chain only #881

dckc · 2023-11-29T08:35:31Z

consolidates the whole page of details on installing the SDK from a git clone to one yarn create @agoric/dapp demo to install from npm packages
replaces ag-solo style initial dapp (card store) with smart-wallet style game piece dapp running on a local chain in a docker container

refs #894, #726

rendered:

getting started

builds on:

feat(create-dapp): npm create @agoric/dapp ... uses agoric init agoric-sdk#8530
- no supported workflow for installing from npm agoric-sdk#3857
- agoric-upgrade-11 NPM packages fail getting started steps agoric-sdk#8380
publish an image of all passed proposals agoric-3-proposals#6
yarn start to aggregate all the start-up steps dapp-offer-up#5

related follow-on work:

cloudflare-workers-and-pages · 2023-11-29T08:38:10Z

Deploying with Cloudflare Pages

Latest commit:	`312d426`
Status:	✅ Deploy successful!
Preview URL:	https://57d4e2e1.documentation-7tp.pages.dev
Branch Preview URL:	https://dc-npm-only.documentation-7tp.pages.dev

View logs

0xpatrickdev · 2023-11-29T20:36:37Z

main/guides/getting-started/README.md

+```sh
+corepack enable
+yarn --version # 1.x
+```


I agree it's best to recommend yarn here, but is it also worth highlighting that other package managers work?

I had success with pnpm and npm like mentioned here.

I was also curious to give yarn 4.x a try, and had luck with this:

# upgrade from yarn classic to yarn 4.x yarn set version berry # disable PnP modules yarn config set nodeLinker node-modules

How about a separate issue?

We would want to set up ci to ensure that other package managers continue to work.

main/guides/getting-started/README.md

toliaqat · 2023-11-30T04:43:08Z

main/guides/getting-started/README.md

+development dependencies for testing, code formatting, and static analysis.
+
+```sh
+yarn install  # may take several minutes


I got the following error when I run yarn install following above instructions.

$ yarn install yarn install v1.22.5 $ node -e "process.env.AGORIC_INSTALL && process.exit(0); console.warn('please use: agoric install . For details, see https://agoric.com/documentation/'); process.exit(1)" please use: agoric install . For details, see https://agoric.com/documentation/ error Command failed with exit code 1. info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.

node --version
v18.12.1

yarn --version
1.22.19

fixed in Agoric/dapp-offer-up@d96fb88 , I think. try again?

toliaqat · 2023-11-30T04:54:48Z

main/guides/getting-started/README.md

-```shell
-yarn build
+```sh
+yarn start


do you plan to wrap all the following commands inside yarn start somehow?

I hope to, yes:

yarn start to aggregate all the start-up steps dapp-offer-up#5

Does this look interesting approach?

https://github.com/agoric-labs/dapp-game-places/compare/tl-auto-approve?expand=1

yes, something like that.

I avoid shell scripts longer than about 10 lines, but I guess it's the right tool for this job.

Due to the way starting the UI clears the screen so that you can't see the mnemonic that you need to add to Keplr, I didn't manage to reduce it to one yarn start command.

But I got close: yarn start:contract and yarn start:ui with keplr setup in between.

toliaqat · 2023-11-30T20:24:06Z

main/guides/getting-started/README.md

+To run a local Agoric blockchain with [docker-compose](https://docs.docker.com/compose/):
+
+```sh
+yarn start:docker


Need to add cd contract for this command to work.
Also, can we change this to be yarn docker:start to match with other docker related commands?

yeah... I'm not sure whether to cd or to tweak the top-level package.json so that it's not necessary.

re start:docker vs docker:start ... I got start:docker from the indexing workshop a while back. I don't know how widespread the convention is. Something to think about, yeah.

I'm not sure whether to cd or to tweak the top-level package.json so that it's not necessary.

I did the tweak:

2023-12-04 17:38 c46b334 build: make docker scripts available at top level

still considering start:docker vs docker:start.

dckc · 2023-12-05T18:59:53Z

main/guides/getting-started/README.md


-Use `yarn link-cli` to install the Agoric CLI (Command Line Interface) in a convenient place of your choosing such as:
+2. Use the [Install Bundle](https://cosgov.org/?msgType=installBundle&network=local) tab to install the 2 bundles.


This has been failing lately:

Request body too large error during Simulate of install bundle DCFoundation/cosmos-proposal-builder#12

@kbennett2000 and @sufyaankhan ran into this, I think. or was it @toliaqat ? or both?

We have some contributions for an single yarn start command that would avoid this.

The "Request body too large" error doesn't look like a cosgov bug but rather a zoe packaging bug:

bundle contains duplicated modules based on duplicated packages in node_modules agoric-sdk#8621

Meanwhile, please take a look at the recent update using a single yarn start:contract command instead of cosgov.

dckc · 2023-12-06T04:24:38Z

Using github for hosting draft images...

draft screenshots

and...

...

don't like this one:

- CLI Commands -> CLI Reference - prune initial "in this order" section in favor of list from `agoric help` - agoric run: brief usage; cite writeCoreProposals discussion - init: deprecate in favor of `yarn create @agoric/dapp` - Syntax -> Usage - markdown lint: `-` rather than `*` for lists; `_` rather than `*` for italic - install: deprecate This is supposed to be able to install from npm. I thought `agoric install agoric-upgrade-11wf` was supposed to do it, but I got an endless series of questions about what versions to use. If we have a form that's tested in ci, I'm not aware of it. Until we do, let's deprecate this. - start local-chain: document briefly - start: deprecate as beta feature - deploy: deprecate as beta feature - open: deprecate as beta feature

- subordinate material with details markup - reorg adding Keplr account - troubleshooting Symbol.dispose error from node v18.19.0 - consolidate linux, mac dev tool details - fix Keplr wallet wallet typo - docker-compose -> docker compose

dckc · 2024-01-03T23:43:54Z

we did #894 instead.

For material in this PR that wasn't covered by #894, I have moved it to separate PRs:

dckc mentioned this pull request Nov 29, 2023

feat: install from npm without clone / agoric install / links Agoric/dapp-offer-up#8

Merged

0xpatrickdev reviewed Nov 29, 2023

View reviewed changes

main/guides/getting-started/README.md Outdated Show resolved Hide resolved

toliaqat reviewed Nov 30, 2023

View reviewed changes

dckc mentioned this pull request Dec 5, 2023

yarn start to aggregate all the start-up steps Agoric/dapp-offer-up#5

Closed

dckc commented Dec 5, 2023

View reviewed changes

dckc force-pushed the dc-npm-only branch 2 times, most recently from 6d88c0d to f2f758f Compare December 6, 2023 10:14

This was referenced Dec 6, 2023

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

Merged

fix: use dapp-offer-up by default Agoric/agoric-sdk#8630

Merged

dckc added 7 commits December 8, 2023 12:44

chore: prune validator sync docs (TODO: redirect to forum)

96921ec

docs(getting-started): install from node; skip ag-solo

ab0558b

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

b184379

docs: use yarn start:contract; add screenshots etc.

718bc8d

docs: Using agd to make queries and transactions

57b8ee2

docs: getting started: fwd ref tx cmds, permissioned deployment

6de5111

dckc force-pushed the dc-npm-only branch from f2f758f to f1aba7d Compare December 8, 2023 23:32

dckc added 2 commits December 8, 2023 20:26

chore(start-a-project): prune from TOC

312d426

dckc force-pushed the dc-npm-only branch from f1aba7d to 312d426 Compare December 9, 2023 02:27

dckc requested a review from kbennett2000 December 9, 2023 02:40

dckc marked this pull request as ready for review December 9, 2023 02:40

dckc changed the title ~~SPIKE: install from npm; smart-wallet / local chain only~~ install from npm; smart-wallet / local chain only Dec 9, 2023

dckc mentioned this pull request Dec 12, 2023

Updated the "Starting a Project" docs to use the new Simple Game Dapp #894

Merged

dckc marked this pull request as draft December 18, 2023 17:46

dckc closed this Jan 3, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

install from npm; smart-wallet / local chain only #881

install from npm; smart-wallet / local chain only #881

dckc commented Nov 29, 2023 •

edited

Loading

cloudflare-workers-and-pages bot commented Nov 29, 2023 •

edited

Loading

0xpatrickdev Nov 29, 2023

dckc Dec 6, 2023

toliaqat Nov 30, 2023

dckc Nov 30, 2023

toliaqat Nov 30, 2023

dckc Nov 30, 2023

toliaqat Nov 30, 2023

dckc Nov 30, 2023

dckc Dec 6, 2023

toliaqat Nov 30, 2023

dckc Nov 30, 2023

dckc Dec 5, 2023

dckc Dec 5, 2023

dckc Dec 5, 2023

dckc Dec 6, 2023

dckc commented Dec 6, 2023 •

edited

Loading

dckc commented Jan 3, 2024


		Use `yarn link-cli` to install the Agoric CLI (Command Line Interface) in a convenient place of your choosing such as:
		2. Use the [Install Bundle](https://cosgov.org/?msgType=installBundle&network=local) tab to install the 2 bundles.

install from npm; smart-wallet / local chain only #881

install from npm; smart-wallet / local chain only #881

Conversation

dckc commented Nov 29, 2023 • edited Loading

cloudflare-workers-and-pages bot commented Nov 29, 2023 • edited Loading

Deploying with Cloudflare Pages

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dckc commented Dec 6, 2023 • edited Loading

dckc commented Jan 3, 2024

dckc commented Nov 29, 2023 •

edited

Loading

cloudflare-workers-and-pages bot commented Nov 29, 2023 •

edited

Loading

dckc commented Dec 6, 2023 •

edited

Loading