@graphprotocol/graph-cli 0.40.0 → 0.40.1-alpha-20230216170945-963badb

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,726 @@
1
+ {
2
+ "version": "0.40.1-alpha-20230216170945-963badb",
3
+ "commands": {
4
+ "add": {
5
+ "id": "add",
6
+ "description": "Adds a new datasource to a subgraph.",
7
+ "strict": true,
8
+ "pluginName": "@graphprotocol/graph-cli",
9
+ "pluginAlias": "@graphprotocol/graph-cli",
10
+ "pluginType": "core",
11
+ "aliases": [],
12
+ "flags": {
13
+ "abi": {
14
+ "name": "abi",
15
+ "type": "option",
16
+ "summary": "Path to the contract ABI.",
17
+ "multiple": false,
18
+ "default": "*Download from Etherscan*"
19
+ },
20
+ "contractName": {
21
+ "name": "contractName",
22
+ "type": "option",
23
+ "summary": "Name of the contract.",
24
+ "multiple": false,
25
+ "default": "Contract"
26
+ },
27
+ "mergeEntities": {
28
+ "name": "mergeEntities",
29
+ "type": "boolean",
30
+ "summary": "Whether to merge entities with the same name.",
31
+ "allowNo": false
32
+ },
33
+ "networkFile": {
34
+ "name": "networkFile",
35
+ "type": "option",
36
+ "summary": "Networks config file path.",
37
+ "multiple": false,
38
+ "default": "networks.json"
39
+ }
40
+ },
41
+ "args": {
42
+ "address": {
43
+ "name": "address",
44
+ "description": "The contract address",
45
+ "required": true
46
+ },
47
+ "subgraphManifest": {
48
+ "name": "subgraphManifest",
49
+ "default": "subgraph.yaml"
50
+ }
51
+ }
52
+ },
53
+ "auth": {
54
+ "id": "auth",
55
+ "description": "Sets the deploy key to use when deploying to a Graph node.",
56
+ "strict": true,
57
+ "pluginName": "@graphprotocol/graph-cli",
58
+ "pluginAlias": "@graphprotocol/graph-cli",
59
+ "pluginType": "core",
60
+ "aliases": [],
61
+ "flags": {
62
+ "product": {
63
+ "name": "product",
64
+ "type": "option",
65
+ "summary": "Select a product for which to authenticate.",
66
+ "multiple": false,
67
+ "options": [
68
+ "subgraph-studio",
69
+ "hosted-service"
70
+ ]
71
+ },
72
+ "studio": {
73
+ "name": "studio",
74
+ "type": "boolean",
75
+ "summary": "Shortcut for \"--product subgraph-studio\".",
76
+ "allowNo": false,
77
+ "exclusive": [
78
+ "product"
79
+ ]
80
+ }
81
+ },
82
+ "args": {
83
+ "node": {
84
+ "name": "node"
85
+ },
86
+ "deploy-key": {
87
+ "name": "deploy-key"
88
+ }
89
+ }
90
+ },
91
+ "build": {
92
+ "id": "build",
93
+ "description": "Builds a subgraph and (optionally) uploads it to IPFS.",
94
+ "strict": true,
95
+ "pluginName": "@graphprotocol/graph-cli",
96
+ "pluginAlias": "@graphprotocol/graph-cli",
97
+ "pluginType": "core",
98
+ "aliases": [],
99
+ "flags": {
100
+ "ipfs": {
101
+ "name": "ipfs",
102
+ "type": "option",
103
+ "char": "i",
104
+ "summary": "Upload build results to an IPFS node.",
105
+ "multiple": false
106
+ },
107
+ "output-dir": {
108
+ "name": "output-dir",
109
+ "type": "option",
110
+ "char": "o",
111
+ "summary": "Output directory for build results.",
112
+ "multiple": false,
113
+ "default": "build/"
114
+ },
115
+ "output-format": {
116
+ "name": "output-format",
117
+ "type": "option",
118
+ "char": "t",
119
+ "summary": "Output format for mappings.",
120
+ "multiple": false,
121
+ "options": [
122
+ "wasm",
123
+ "wast"
124
+ ],
125
+ "default": "wasm"
126
+ },
127
+ "skip-migrations": {
128
+ "name": "skip-migrations",
129
+ "type": "boolean",
130
+ "summary": "Skip subgraph migrations.",
131
+ "allowNo": false
132
+ },
133
+ "watch": {
134
+ "name": "watch",
135
+ "type": "boolean",
136
+ "char": "w",
137
+ "summary": "Regenerate types when subgraph files change.",
138
+ "allowNo": false
139
+ },
140
+ "network": {
141
+ "name": "network",
142
+ "type": "option",
143
+ "summary": "Network configuration to use from the networks config file.",
144
+ "multiple": false
145
+ },
146
+ "network-file": {
147
+ "name": "network-file",
148
+ "type": "option",
149
+ "summary": "Networks config file path.",
150
+ "multiple": false,
151
+ "default": "networks.json"
152
+ }
153
+ },
154
+ "args": {
155
+ "subgraph-manifest": {
156
+ "name": "subgraph-manifest",
157
+ "default": "subgraph.yaml"
158
+ }
159
+ }
160
+ },
161
+ "codegen": {
162
+ "id": "codegen",
163
+ "description": "Generates AssemblyScript types for a subgraph.",
164
+ "strict": true,
165
+ "pluginName": "@graphprotocol/graph-cli",
166
+ "pluginAlias": "@graphprotocol/graph-cli",
167
+ "pluginType": "core",
168
+ "aliases": [],
169
+ "flags": {
170
+ "output-dir": {
171
+ "name": "output-dir",
172
+ "type": "option",
173
+ "char": "o",
174
+ "summary": "Output directory for generated types.",
175
+ "multiple": false,
176
+ "default": "generated/"
177
+ },
178
+ "skip-migrations": {
179
+ "name": "skip-migrations",
180
+ "type": "boolean",
181
+ "summary": "Skip subgraph migrations.",
182
+ "allowNo": false
183
+ },
184
+ "watch": {
185
+ "name": "watch",
186
+ "type": "boolean",
187
+ "char": "w",
188
+ "summary": "Regenerate types when subgraph files change.",
189
+ "allowNo": false
190
+ },
191
+ "uncrashable": {
192
+ "name": "uncrashable",
193
+ "type": "boolean",
194
+ "char": "u",
195
+ "summary": "Generate Float Subgraph Uncrashable helper file.",
196
+ "allowNo": false
197
+ },
198
+ "uncrashable-config": {
199
+ "name": "uncrashable-config",
200
+ "type": "option",
201
+ "summary": "Directory for uncrashable config.",
202
+ "multiple": false,
203
+ "dependsOn": [
204
+ "uncrashable"
205
+ ],
206
+ "default": "uncrashable-config.yaml",
207
+ "aliases": [
208
+ "uc"
209
+ ]
210
+ }
211
+ },
212
+ "args": {
213
+ "subgraph-manifest": {
214
+ "name": "subgraph-manifest",
215
+ "required": true
216
+ }
217
+ }
218
+ },
219
+ "create": {
220
+ "id": "create",
221
+ "description": "Registers a subgraph name",
222
+ "strict": true,
223
+ "pluginName": "@graphprotocol/graph-cli",
224
+ "pluginAlias": "@graphprotocol/graph-cli",
225
+ "pluginType": "core",
226
+ "aliases": [],
227
+ "flags": {
228
+ "node": {
229
+ "name": "node",
230
+ "type": "option",
231
+ "char": "g",
232
+ "summary": "Graph node to create the subgraph in.",
233
+ "required": true,
234
+ "multiple": false
235
+ },
236
+ "access-token": {
237
+ "name": "access-token",
238
+ "type": "option",
239
+ "summary": "Graph access token.",
240
+ "multiple": false
241
+ }
242
+ },
243
+ "args": {
244
+ "subgraph-name": {
245
+ "name": "subgraph-name",
246
+ "required": true
247
+ }
248
+ }
249
+ },
250
+ "deploy": {
251
+ "id": "deploy",
252
+ "description": "Deploys a subgraph to a Graph node.",
253
+ "strict": true,
254
+ "pluginName": "@graphprotocol/graph-cli",
255
+ "pluginAlias": "@graphprotocol/graph-cli",
256
+ "pluginType": "core",
257
+ "aliases": [],
258
+ "flags": {
259
+ "product": {
260
+ "name": "product",
261
+ "type": "option",
262
+ "summary": "Select a product for which to authenticate.",
263
+ "multiple": false,
264
+ "options": [
265
+ "subgraph-studio",
266
+ "hosted-service"
267
+ ]
268
+ },
269
+ "studio": {
270
+ "name": "studio",
271
+ "type": "boolean",
272
+ "summary": "Shortcut for \"--product subgraph-studio\".",
273
+ "allowNo": false,
274
+ "exclusive": [
275
+ "product"
276
+ ]
277
+ },
278
+ "node": {
279
+ "name": "node",
280
+ "type": "option",
281
+ "char": "g",
282
+ "summary": "Graph node for which to initialize.",
283
+ "multiple": false
284
+ },
285
+ "deploy-key": {
286
+ "name": "deploy-key",
287
+ "type": "option",
288
+ "summary": "User deploy key.",
289
+ "required": true,
290
+ "multiple": false,
291
+ "exclusive": [
292
+ "access-token"
293
+ ]
294
+ },
295
+ "access-token": {
296
+ "name": "access-token",
297
+ "type": "option",
298
+ "summary": "Graph access key. DEPRECATED: Use \"--deploy-key\" instead.",
299
+ "multiple": false,
300
+ "exclusive": [
301
+ "deploy-key"
302
+ ],
303
+ "deprecated": true
304
+ },
305
+ "version-label": {
306
+ "name": "version-label",
307
+ "type": "option",
308
+ "char": "l",
309
+ "summary": "Version label used for the deployment.",
310
+ "multiple": false
311
+ },
312
+ "ipfs": {
313
+ "name": "ipfs",
314
+ "type": "option",
315
+ "char": "i",
316
+ "summary": "Upload build results to an IPFS node.",
317
+ "multiple": false,
318
+ "default": "https://api.thegraph.com/ipfs/"
319
+ },
320
+ "headers": {
321
+ "name": "headers",
322
+ "type": "option",
323
+ "summary": "Add custom headers that will be used by the IPFS HTTP client.",
324
+ "multiple": false,
325
+ "default": {},
326
+ "aliases": [
327
+ "hdr"
328
+ ]
329
+ },
330
+ "debug-fork": {
331
+ "name": "debug-fork",
332
+ "type": "option",
333
+ "summary": "ID of a remote subgraph whose store will be GraphQL queried.",
334
+ "multiple": false
335
+ },
336
+ "output-dir": {
337
+ "name": "output-dir",
338
+ "type": "option",
339
+ "char": "o",
340
+ "summary": "Output directory for build results.",
341
+ "multiple": false,
342
+ "default": "build/"
343
+ },
344
+ "skip-migrations": {
345
+ "name": "skip-migrations",
346
+ "type": "boolean",
347
+ "summary": "Skip subgraph migrations.",
348
+ "allowNo": false
349
+ },
350
+ "watch": {
351
+ "name": "watch",
352
+ "type": "boolean",
353
+ "char": "w",
354
+ "summary": "Regenerate types when subgraph files change.",
355
+ "allowNo": false
356
+ },
357
+ "network": {
358
+ "name": "network",
359
+ "type": "option",
360
+ "summary": "Network configuration to use from the networks config file.",
361
+ "multiple": false
362
+ },
363
+ "network-file": {
364
+ "name": "network-file",
365
+ "type": "option",
366
+ "summary": "Networks config file path.",
367
+ "multiple": false,
368
+ "default": "networks.json"
369
+ }
370
+ },
371
+ "args": {
372
+ "subgraph-name": {
373
+ "name": "subgraph-name",
374
+ "required": true
375
+ },
376
+ "subgraph-manifest": {
377
+ "name": "subgraph-manifest",
378
+ "default": "subgraph.yaml"
379
+ }
380
+ }
381
+ },
382
+ "init": {
383
+ "id": "init",
384
+ "description": "Creates a new subgraph with basic scaffolding.",
385
+ "strict": true,
386
+ "pluginName": "@graphprotocol/graph-cli",
387
+ "pluginAlias": "@graphprotocol/graph-cli",
388
+ "pluginType": "core",
389
+ "aliases": [],
390
+ "flags": {
391
+ "protocol": {
392
+ "name": "protocol",
393
+ "type": "option",
394
+ "required": true,
395
+ "multiple": false,
396
+ "options": [
397
+ "arweave",
398
+ "ethereum",
399
+ "near",
400
+ "cosmos",
401
+ "substreams"
402
+ ]
403
+ },
404
+ "product": {
405
+ "name": "product",
406
+ "type": "option",
407
+ "summary": "Selects the product for which to initialize.",
408
+ "multiple": false,
409
+ "options": [
410
+ "subgraph-studio",
411
+ "hosted-service"
412
+ ]
413
+ },
414
+ "studio": {
415
+ "name": "studio",
416
+ "type": "boolean",
417
+ "summary": "Shortcut for \"--product subgraph-studio\".",
418
+ "allowNo": false,
419
+ "exclusive": [
420
+ "product"
421
+ ]
422
+ },
423
+ "node": {
424
+ "name": "node",
425
+ "type": "option",
426
+ "char": "g",
427
+ "summary": "Graph node for which to initialize.",
428
+ "multiple": false
429
+ },
430
+ "allow-simple-name": {
431
+ "name": "allow-simple-name",
432
+ "type": "boolean",
433
+ "description": "Use a subgraph name without a prefix.",
434
+ "allowNo": false
435
+ },
436
+ "from-contract": {
437
+ "name": "from-contract",
438
+ "type": "option",
439
+ "description": "Creates a scaffold based on an existing contract.",
440
+ "multiple": false,
441
+ "exclusive": [
442
+ "from-example"
443
+ ]
444
+ },
445
+ "from-example": {
446
+ "name": "from-example",
447
+ "type": "option",
448
+ "description": "Creates a scaffold based on an example subgraph.",
449
+ "multiple": false,
450
+ "exclusive": [
451
+ "from-contract"
452
+ ],
453
+ "default": "Contract"
454
+ },
455
+ "contract-name": {
456
+ "name": "contract-name",
457
+ "type": "option",
458
+ "description": "Name of the contract.",
459
+ "helpGroup": "Scaffold from contract",
460
+ "multiple": false,
461
+ "dependsOn": [
462
+ "from-contract"
463
+ ]
464
+ },
465
+ "index-events": {
466
+ "name": "index-events",
467
+ "type": "boolean",
468
+ "description": "Index contract events as entities.",
469
+ "helpGroup": "Scaffold from contract",
470
+ "allowNo": false,
471
+ "dependsOn": [
472
+ "from-contract"
473
+ ]
474
+ },
475
+ "start-block": {
476
+ "name": "start-block",
477
+ "type": "option",
478
+ "description": "Block number to start indexing from.",
479
+ "helpGroup": "Scaffold from contract",
480
+ "multiple": false,
481
+ "dependsOn": [
482
+ "from-contract"
483
+ ]
484
+ },
485
+ "abi": {
486
+ "name": "abi",
487
+ "type": "option",
488
+ "summary": "Path to the contract ABI",
489
+ "multiple": false,
490
+ "dependsOn": [
491
+ "from-contract"
492
+ ]
493
+ },
494
+ "network": {
495
+ "name": "network",
496
+ "type": "option",
497
+ "summary": "Network the contract is deployed to.",
498
+ "multiple": false,
499
+ "options": [
500
+ "mainnet",
501
+ "rinkeby",
502
+ "goerli",
503
+ "poa-core",
504
+ "poa-sokol",
505
+ "gnosis",
506
+ "matic",
507
+ "mumbai",
508
+ "fantom",
509
+ "fantom-testnet",
510
+ "bsc",
511
+ "chapel",
512
+ "clover",
513
+ "avalanche",
514
+ "fuji",
515
+ "celo",
516
+ "celo-alfajores",
517
+ "fuse",
518
+ "moonbeam",
519
+ "moonriver",
520
+ "mbase",
521
+ "arbitrum-one",
522
+ "arbitrum-goerli",
523
+ "optimism",
524
+ "optimism-kovan",
525
+ "aurora",
526
+ "aurora-testnet",
527
+ "near-mainnet",
528
+ "near-testnet",
529
+ "cosmoshub-4",
530
+ "theta-testnet-001",
531
+ "osmosis-1",
532
+ "osmo-test-4",
533
+ "juno-1",
534
+ "uni-3"
535
+ ],
536
+ "dependsOn": [
537
+ "from-contract"
538
+ ]
539
+ }
540
+ },
541
+ "args": {
542
+ "subgraphName": {
543
+ "name": "subgraphName",
544
+ "required": true
545
+ },
546
+ "directory": {
547
+ "name": "directory",
548
+ "required": true
549
+ }
550
+ }
551
+ },
552
+ "local": {
553
+ "id": "local",
554
+ "description": "Runs local tests against a Graph Node environment (using Ganache by default).",
555
+ "strict": true,
556
+ "pluginName": "@graphprotocol/graph-cli",
557
+ "pluginAlias": "@graphprotocol/graph-cli",
558
+ "pluginType": "core",
559
+ "aliases": [],
560
+ "flags": {
561
+ "node-logs": {
562
+ "name": "node-logs",
563
+ "type": "boolean",
564
+ "summary": "Print the Graph Node logs.",
565
+ "allowNo": false
566
+ },
567
+ "ethereum-logs": {
568
+ "name": "ethereum-logs",
569
+ "type": "boolean",
570
+ "summary": "Print the Ethereum logs.",
571
+ "allowNo": false
572
+ },
573
+ "compose-file": {
574
+ "name": "compose-file",
575
+ "type": "option",
576
+ "summary": "Custom Docker Compose file for additional services.",
577
+ "multiple": false
578
+ },
579
+ "node-image": {
580
+ "name": "node-image",
581
+ "type": "option",
582
+ "summary": "Custom Graph Node image to test against.",
583
+ "multiple": false,
584
+ "default": "graphprotocol/graph-node:latest"
585
+ },
586
+ "standalone-node": {
587
+ "name": "standalone-node",
588
+ "type": "option",
589
+ "summary": "Use a standalone Graph Node outside Docker Compose.",
590
+ "multiple": false
591
+ },
592
+ "standalone-node-args": {
593
+ "name": "standalone-node-args",
594
+ "type": "option",
595
+ "summary": "Custom arguments to be passed to the standalone Graph Node.",
596
+ "multiple": false,
597
+ "dependsOn": [
598
+ "standalone-node"
599
+ ]
600
+ },
601
+ "skip-wait-for-ipfs": {
602
+ "name": "skip-wait-for-ipfs",
603
+ "type": "boolean",
604
+ "summary": "Don't wait for IPFS to be up at localhost:15001",
605
+ "allowNo": false
606
+ },
607
+ "skip-wait-for-etherium": {
608
+ "name": "skip-wait-for-etherium",
609
+ "type": "boolean",
610
+ "summary": "Don't wait for Ethereum to be up at localhost:18545",
611
+ "allowNo": false
612
+ },
613
+ "skip-wait-for-postgres": {
614
+ "name": "skip-wait-for-postgres",
615
+ "type": "boolean",
616
+ "summary": "Don't wait for Postgres to be up at localhost:15432",
617
+ "allowNo": false
618
+ },
619
+ "timeout": {
620
+ "name": "timeout",
621
+ "type": "option",
622
+ "summary": "Time to wait for service containers in milliseconds.",
623
+ "multiple": false,
624
+ "default": 120000
625
+ }
626
+ },
627
+ "args": {
628
+ "local-command": {
629
+ "name": "local-command",
630
+ "required": true
631
+ }
632
+ }
633
+ },
634
+ "remove": {
635
+ "id": "remove",
636
+ "description": "Unregisters a subgraph name",
637
+ "strict": true,
638
+ "pluginName": "@graphprotocol/graph-cli",
639
+ "pluginAlias": "@graphprotocol/graph-cli",
640
+ "pluginType": "core",
641
+ "aliases": [],
642
+ "flags": {
643
+ "node": {
644
+ "name": "node",
645
+ "type": "option",
646
+ "char": "g",
647
+ "summary": "Graph node to delete the subgraph from.",
648
+ "required": true,
649
+ "multiple": false
650
+ },
651
+ "access-token": {
652
+ "name": "access-token",
653
+ "type": "option",
654
+ "summary": "Graph access token.",
655
+ "multiple": false
656
+ }
657
+ },
658
+ "args": {
659
+ "subgraph-name": {
660
+ "name": "subgraph-name",
661
+ "required": true
662
+ }
663
+ }
664
+ },
665
+ "test": {
666
+ "id": "test",
667
+ "description": "Runs rust binary for subgraph testing.",
668
+ "strict": true,
669
+ "pluginName": "@graphprotocol/graph-cli",
670
+ "pluginAlias": "@graphprotocol/graph-cli",
671
+ "pluginType": "core",
672
+ "aliases": [],
673
+ "flags": {
674
+ "coverage": {
675
+ "name": "coverage",
676
+ "type": "boolean",
677
+ "char": "c",
678
+ "summary": "Run the tests in coverage mode.",
679
+ "allowNo": false
680
+ },
681
+ "docker": {
682
+ "name": "docker",
683
+ "type": "boolean",
684
+ "char": "d",
685
+ "summary": "Run the tests in a docker container (Note: Please execute from the root folder of the subgraph).",
686
+ "allowNo": false
687
+ },
688
+ "force": {
689
+ "name": "force",
690
+ "type": "boolean",
691
+ "char": "f",
692
+ "summary": "Binary - overwrites folder + file when downloading. Docker - rebuilds the docker image.",
693
+ "allowNo": false
694
+ },
695
+ "logs": {
696
+ "name": "logs",
697
+ "type": "boolean",
698
+ "char": "l",
699
+ "summary": "Logs to the console information about the OS, CPU model and download url (debugging purposes).",
700
+ "allowNo": false
701
+ },
702
+ "recompile": {
703
+ "name": "recompile",
704
+ "type": "boolean",
705
+ "char": "r",
706
+ "summary": "Force-recompile tests.",
707
+ "allowNo": false
708
+ },
709
+ "version": {
710
+ "name": "version",
711
+ "type": "option",
712
+ "char": "v",
713
+ "summary": "Choose the version of the rust binary that you want to be downloaded/used.",
714
+ "required": true,
715
+ "multiple": false
716
+ }
717
+ },
718
+ "args": {
719
+ "datasource": {
720
+ "name": "datasource",
721
+ "required": true
722
+ }
723
+ }
724
+ }
725
+ }
726
+ }