Simplify commands used in README instructions #62

michaelfig · 2023-11-14T00:05:59Z

Lightly tested, but this is the approach I'd like to take.

@sufyaankhan, please take a look at README.md for how this architecture simplifies the flow.

Recommendations appreciated.

michaelfig · 2023-11-14T00:10:52Z

Here is how it currently fails (because @agoric/xsnap is broken in the beta packages):

$ yarn start
yarn run v1.22.5
$ concurrently --kill-others -c "bgBlue.bold,bgMagenta,bgYellow.bold" --names "SIM,DEP,UI " "yarn start:sim" "yarn start:deploy" "yarn start:ui"
$ agoric deploy contract/deploy.js api/deploy.js
$ agoric start --reset
$ cd ui && yarn start
$ parcel serve --host=127.0.0.1 --port=3000 public/index.html
[DEP] Open CapTP connection to ws://127.0.0.1:8000/private/captp...agoric: start: removing _agstate/agoric-servers/dev
[SIM] agoric: start: rm -rf _agstate/agoric-servers/dev
[SIM] agoric: start: initializing dev
[SIM] agoric: start: /Users/michael/agoric/dapp-fungible-faucet/node_modules/@agoric/solo/src/entrypoint.js init dev --egresses=fake --webport=8000
[UI ] Server running at http://127.0.0.1:3000
[UI ] ✨ Built in 7ms
[SIM] agoric: start: setting sim chain with 0 second delay
[SIM] agoric: start: /Users/michael/agoric/dapp-fungible-faucet/node_modules/@agoric/solo/src/entrypoint.js set-fake-chain --delay=0 sim-chain
[DEP] .agoric: start: /Users/michael/agoric/dapp-fungible-faucet/node_modules/@agoric/solo/src/entrypoint.js start
[DEP] ......Loading makeSlogSender from @agoric/telemetry/src/flight-recorder.js
[SIM] (Error#1)
[SIM] Error#1: spawn /Users/michael/agoric/dapp-fungible-faucet/node_modules/@agoric/xsnap/xsnap-native/xsnap/build/bin/mac/release/xsnap-worker ENOENT
[SIM] 
error Command failed with exit code 255.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
[SIM] yarn start:sim exited with code 255
--> Sending SIGTERM to other processes..
[DEP] yarn start:deploy exited with code 1
--> Sending SIGTERM to other processes..
[UI ] yarn start:ui exited with code 1
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
snow:dapp-fungible-faucet michael$

michaelfig · 2023-11-14T02:35:42Z

After yarn agoric install agoric-upgrade-12 didn't fix the issue, I found that the actual problem was in the @agoric/xsnap/package.json. It was using git status to detect if the package was in development vs. production mode, and that gave wrong answers when installed within a dapp project. I switched it to use test -d ./test to detect development mode (since the ./test directory is omitted from the NPM package).

Now I was able to run the README instructions to completion (contract successfully deployed), and the next broken thing appeared to be a problem with running an older ses in the dapp UI.

I call this a victory.

mhofman

Use getting-started-dev instead of beta

mhofman

Quick review. Looks great so far. I have to dig out my notes of when I went through the same a couple month ago.

mhofman · 2023-11-15T15:44:21Z

.github/workflows/integration-test.yml

+      run: |
+        if ${{ steps.get-branch.outputs.result == 'NONE' }}; then
+          yarn install
+          echo "AGORIC_CMD=[\"$PWD/node_modules/.bin/agoric\"]" >> $GITHUB_ENV


Is there a way we can avoid this workaround? What is it needed for anyway?

The agoric-cli/tools integration test needs to know how to find the CLI, and it defaults to using the PATH. I didn't want to munge with the $GITHUB_PATH file, so I used the same $AGORIC_CMD environment variable that the agoric-sdk/scripts/registry.sh uses.

Oh I didn't see this used anywhere, so I thought it was a magic env

mhofman · 2023-11-15T15:45:17Z

api/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "dapp-fungible-faucet-api",
+  "name": "@agoric/dapp-fungible-faucet-api",


I kinda wish we used another scope for these example dapps

Why? The names get replaced when people do npm create or agoric init.

I guess if these packages are never published to NPM, that's fine.

mhofman · 2023-11-15T15:45:52Z

api/package.json

  "dependencies": {
    "@endo/eventual-send": "^0.15.5",
    "@endo/marshal": "^0.6.9",
+    "@agoric/dapp-fungible-faucet-ui": "^0.0.1",


The API having a dependency on the UI seems backwards

I can try to flip this around, but it was this way when I arrived here.

Yeah it's out of scope, but maybe we should have an issue to track

mhofman · 2023-11-15T15:47:20Z

package.json

@@ -55,7 +57,8 @@
  "eslintConfig": {
    "extends": [
      "@agoric"
-    ]
+    ],
+    "parser": "@typescript-eslint/parser"


mhofman · 2023-11-15T15:48:57Z

api/deploy.js

 // Agoric Dapp api deployment script

 import fs from 'fs';
 import { E } from '@endo/eventual-send';
 import '@agoric/zoe/exported.js';

-import installationConstants from '../ui/public/conf/installationConstants.js';
+import installationConstants from "@agoric/dapp-fungible-faucet-ui/public/conf/installationConstants.js";


Oh that's the dependency. Yeah this really feels backwards

Addressed

mhofman · 2023-11-15T17:52:30Z

For reference, I had done something similar to dapp-card-store a couple month ago, but our approach on a some deps seem to have been different in a couple places: Agoric/dapp-card-store@main...mhofman/npm-latest

mhofman · 2023-12-29T18:41:30Z

@dckc another set of dapp work for NPM compatibility during the hackathon

dckc · 2023-12-29T22:17:01Z

I'd be inclined to mothball (archive) this dapp. I don't think it's worth maintaining.

michaelfig · 2024-02-05T01:43:53Z

I'm closing this one since we're not putting more energy into dapp-fungible-faucet. The history here might be useful for someone in the future, though.

michaelfig self-assigned this Nov 14, 2023

michaelfig requested review from mhofman and sufyaankhan November 14, 2023 00:08

mhofman previously requested changes Nov 14, 2023

View reviewed changes

michaelfig force-pushed the mfig-hack-getting-started branch from 1346578 to 1e3f6f4 Compare November 14, 2023 16:52

michaelfig changed the title ~~WIP: simplify commands used in README instructions~~ Simplify commands used in README instructions Nov 14, 2023

michaelfig requested a review from mhofman November 14, 2023 18:55

michaelfig marked this pull request as ready for review November 14, 2023 18:55

michaelfig force-pushed the mfig-hack-getting-started branch from 1e3f6f4 to b6a1921 Compare November 14, 2023 19:28

michaelfig added 2 commits November 15, 2023 09:09

build: simplified README instructions

a9cb00a

build(deps): agoric install getting-started-dev

d480f75

michaelfig force-pushed the mfig-hack-getting-started branch 3 times, most recently from c2c1579 to c4698b6 Compare November 15, 2023 15:43

mhofman reviewed Nov 15, 2023

View reviewed changes

michaelfig added 6 commits November 15, 2023 10:22

build: regenerate yarn.lock

b0cbef1

ci: update for Node 18

c3c08cb

build(deps): update package deps

0add96f

build: regenerate yarn.lock

7d00193

test(contract): remove Zoe fee purse bindings

9094af1

chore: fix lint

c164203

michaelfig force-pushed the mfig-hack-getting-started branch from c4698b6 to c164203 Compare November 15, 2023 16:33

michaelfig added 3 commits November 15, 2023 12:51

fix(ui): work around parcel sloppy mode bug

04a283c

build: regenerate yarn.lock

ff53abe

chore: fix lint

5963316

michaelfig force-pushed the mfig-hack-getting-started branch from 122bc74 to 5963316 Compare November 15, 2023 21:01

michaelfig closed this Feb 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Simplify commands used in README instructions #62

Simplify commands used in README instructions #62

michaelfig commented Nov 14, 2023 •

edited

Loading

michaelfig commented Nov 14, 2023

michaelfig commented Nov 14, 2023

mhofman left a comment

mhofman left a comment

mhofman Nov 15, 2023

michaelfig Nov 15, 2023

mhofman Nov 15, 2023

mhofman Nov 15, 2023

michaelfig Nov 15, 2023

mhofman Nov 15, 2023

mhofman Nov 15, 2023

michaelfig Nov 15, 2023

mhofman Nov 15, 2023

mhofman Nov 15, 2023

mhofman Nov 15, 2023

mhofman commented Nov 15, 2023

mhofman commented Dec 29, 2023

dckc commented Dec 29, 2023

michaelfig commented Feb 5, 2024

Simplify commands used in README instructions #62

Simplify commands used in README instructions #62

Conversation

michaelfig commented Nov 14, 2023 • edited Loading

michaelfig commented Nov 14, 2023

michaelfig commented Nov 14, 2023

mhofman left a comment

Choose a reason for hiding this comment

mhofman left a 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

mhofman commented Nov 15, 2023

mhofman commented Dec 29, 2023

dckc commented Dec 29, 2023

michaelfig commented Feb 5, 2024

michaelfig commented Nov 14, 2023 •

edited

Loading