Add graph init with --from-example and --from-contract modes #224

Jannis · 2019-03-07T12:19:13Z

This supersedes #216 by supporting both the old and the new graph init via

--from-example and
--from-contract <address>

mode flags.

TODO

Update README
Update docs on https://thegraph.com/docs/

Example usage

If all arguments are provided for either mode, graph init will run in non-interactive mode:

# From the example subgraph:
graph init --from-example user/subgraph-name output-dir
graph init --from-example --allow-simple-name subgraph-name output-dir

# From an existing contract:
graph init \
  --from-contract 0xF87E31492Faf9A91B02Ee0dEAAd50d51d56D5d4d \
  --network mainnet \
  user/subgraph-name \
  output-dir

If one or more arguments are not provided, graph init will run the user through an interactive form to create a subgraph from an existing contract, pre-populating fields with the provided values:

$ graph init --from-contract 0xF87E31492Faf9A91B02Ee0dEAAd50d51d56D5d4d jannis/decentraland-land
✔ Subgraph name · jannis/decentraland-land
✔ Directory to create the subgraph in · land
✔ Ethereum network · mainnet
✔ Contract address · 0xF87E31492Faf9A91B02Ee0dEAAd50d51d56D5d4d
✔ Fetching ABI from Etherscan
———
  Generate subgraph from ABI
  Write subgraph to directory
✔ Create subgraph scaffold
✔ Initialize subgraph repository
✔ Install dependencies with yarn
✔ Generate ABI and schema types with yarn codegen

Subgraph jannis/decentraland-land created in land

Next steps:

  1. Run `graph auth https://api.thegraph.com/deploy/ <access-token>`
     to authenticate with the hosted service. You can get the access token from
     https://thegraph.com/explorer/dashboard/.

  2. Type `cd land` to enter the subgraph.

  3. Run `yarn deploy` to deploy the subgraph to
     https://thegraph.com/explorer/subgraph/jannis/decentraland-land.

Make sure to visit the documentation on https://thegraph.com/docs/ for further information.

If an ABI cannot be found on Etherscan, this form asks for a local ABI file path:

$ graph init --from-contract 0xF87E31492Faf9A91B02Ee0dEAAd50d51d56D5d4f jannis/decentraland-land
✔ Subgraph name · jannis/decentraland-land
✔ Directory to create the subgraph in · land-2
✔ Ethereum network · mainnet
✔ Contract address · 0xF87E31492Faf9A91B02Ee0dEAAd50d51d56D5d4f
✖ Failed to fetch ABI from Etherscan: Unexpected token C in JSON at position 0
✔ ABI file (path) · /Users/jannis/Work/graphprotocol/subgraphs/decentraland/abis/LANDRegistry.json
———
  Generate subgraph from ABI
  Write subgraph to directory
✔ Create subgraph scaffold
✔ Initialize subgraph repository
⠋ Install dependencies with yarn
...

…erscan

Users can choose between these two modes. If they provide all the different values that each of the modes needs, the interactive form is bypassed, allowing the new `graph init` to be used in non-interactive environments such as CI.

…e controlled)

src/scaffold.js

leoyvens · 2019-03-08T16:10:00Z

The "Next steps:" instructions don't instruct me to run codegen, which is necessary before deploy.

Jannis · 2019-03-08T20:32:45Z

@leodasvacas That's because graph init runs it for you 😉

leoyvens · 2019-03-08T22:51:15Z

@Jannis ah nice, I got confused because of the /generated issue.

leoyvens

A bunch of small comments. Nice tests! It would be cool to also have a test for the generated contents.

src/commands/init.js

leoyvens · 2019-03-12T20:24:12Z

src/commands/init.js

+    })
+
+    if (inputs === undefined) {
+      process.exit(1)


Does inputs === undefined have a particular meaning? Should we print something here?

The inputs are undefined if the form is cancelled. I've added a comment.

Where's the comment?

https://github.com/graphprotocol/graph-cli/blob/jannis/graph-init-with-two-modes/src/commands/init.js#L281 😉

src/commands/init.js

src/scaffold.js

Jannis · 2019-03-12T21:25:05Z

Thanks @leodasvacas, I'll address the comments in the morning!

This behavior showed when using --from-example without an internet connection. Now it prints the actual error instead of silently failing.

Jannis · 2019-03-14T12:58:01Z

@leodasvacas I've fixed a few things, added a few comments and tried to address with comments with replies. Let me know what you think.

leoyvens · 2019-03-14T13:50:20Z

src/scaffold.js

+          subgraphName,
+      },
+      dependencies: {
+        '@graphprotocol/graph-cli': '0.7.2',


We'll need to be careful to remember to update this, at least on breaking changes.

Indeed. I have an idea: How about we take the package version and put it in here? Then we're always up to date.

If that's possible that would be great.

Jannis Pohlmann added 15 commits March 6, 2019 20:17

commands/init, scaffold: Add subgraph scaffolding using address + Eth…

6004a61

…erscan

commands/init: Make Etherscan ABI download work with testnets

9cf69da

scaffold: Avoid semicolons in the generated mapping

66680f8

commands/init: Make output prettier

1c3979e

commands/init: Handle ABIs without events

281470f

commands/init: Fix loading ABIs from local files

f8e278b

scaffold: Handle unnamed event parameters correctly

48d51ad

commands/init: Avoid duplicating event counting logic

611a717

codegen: Implement getting value types from AssemblyScript types

8599321

scaffold: Handle all Ethereum event parameter types properly

6e41e2b

tests/cli: Make testCli more flexible (allow CLI command and cwd to b…

01c15d7

…e controlled)

tests/cli/validation: Pass 'codegen' command to cliTest

aebb8f0

NPM, Yarn: Add strip-ansi to development dependencies

25fc7e0

tests/cli/init: Add positive tests for non-interactive graph init

550de17

Jannis added developer experience new feature labels Mar 7, 2019

Jannis added this to the Q1 2019 milestone Mar 7, 2019

Jannis self-assigned this Mar 7, 2019

Jannis requested a review from a team March 7, 2019 12:19

ghost added the pending review label Mar 7, 2019

Jannis added the area/cli label Mar 7, 2019

Jannis changed the title ~~Add graph init with --from-example and --from-contract modes~~ Add graph init with --from-example and --from-contract modes Mar 7, 2019

Jannis Pohlmann added 2 commits March 7, 2019 13:41

NPM, Yarn: Add missing node-fetch dependency

6ca943d

NPM, Yarn: Bump jest to v24.3.0

e56d994

leoyvens reviewed Mar 8, 2019

View reviewed changes

src/scaffold.js Show resolved Hide resolved

README: Update commands, refer to the official docs for getting started

d20f09f

leoyvens requested changes Mar 12, 2019

View reviewed changes

Jannis mentioned this pull request Mar 12, 2019

Add workaround for boolean CLI option bug to all commands #231

Closed

Jannis Pohlmann added 5 commits March 14, 2019 13:21

command-helpers/gluegun: Improve fixParameters and add documentation

9b3af7c

commands/init: Handle fixParameter errors

54edc8a

commands: Use fixParameters in all commands where it makes sense

6dc67d8

commands/init: Add comment for when the form is cancelled

5987a6c

commands/init: Don't fail silently in --from-example

efcf205

This behavior showed when using --from-example without an internet connection. Now it prints the actual error instead of silently failing.

Jannis Pohlmann added 2 commits March 14, 2019 14:23

scaffold: Remove outdated comment

f43024d

commands/init: Add comment for removing .git in --from-example mode

1bf7373

leoyvens reviewed Mar 14, 2019

View reviewed changes

leoyvens previously approved these changes Mar 14, 2019

View reviewed changes

scaffold: Automatically use the latest graph-cli version

be125ee

Jannis dismissed leoyvens’s stale review via be125ee March 14, 2019 14:04

leoyvens approved these changes Mar 14, 2019

View reviewed changes

Jannis merged commit 3e6d2e0 into master Mar 14, 2019

ghost removed the pending review label Mar 14, 2019

This was referenced Apr 8, 2019

Make graph init platform agnostic (non rm and bash execution) #211

Closed

Scaffolding from ABIs #145

Closed

saihaj deleted the jannis/graph-init-with-two-modes branch May 12, 2023 15:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add graph init with --from-example and --from-contract modes #224

Add graph init with --from-example and --from-contract modes #224

Jannis commented Mar 7, 2019 •

edited

leoyvens commented Mar 8, 2019

Jannis commented Mar 8, 2019

leoyvens commented Mar 8, 2019

leoyvens left a comment

leoyvens Mar 12, 2019

Jannis Mar 14, 2019

leoyvens Mar 14, 2019

Jannis Mar 14, 2019

Jannis commented Mar 12, 2019

Jannis commented Mar 14, 2019

leoyvens Mar 14, 2019

Jannis Mar 14, 2019

leoyvens Mar 14, 2019

Add graph init with --from-example and --from-contract modes #224

Add graph init with --from-example and --from-contract modes #224

Conversation

Jannis commented Mar 7, 2019 • edited

TODO

Example usage

leoyvens commented Mar 8, 2019

Jannis commented Mar 8, 2019

leoyvens commented Mar 8, 2019

leoyvens left a comment

Choose a reason for hiding this comment

leoyvens Mar 12, 2019

Choose a reason for hiding this comment

Jannis Mar 14, 2019

Choose a reason for hiding this comment

leoyvens Mar 14, 2019

Choose a reason for hiding this comment

Jannis Mar 14, 2019

Choose a reason for hiding this comment

Jannis commented Mar 12, 2019

Jannis commented Mar 14, 2019

leoyvens Mar 14, 2019

Choose a reason for hiding this comment

Jannis Mar 14, 2019

Choose a reason for hiding this comment

leoyvens Mar 14, 2019

Choose a reason for hiding this comment

Jannis commented Mar 7, 2019 •

edited