docs: Indexer service network endpoint

graphprotocol · May 25, 2022 · 2a2352b · 2a2352b
1 parent 48c6d1c
commit 2a2352b
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 48 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Changelog
 
+# [1.9.0](https://github.com/graphprotocol/AllocationOpt.jl/compare/v1.8.0...v1.9.0) (2022-05-25)
+
+
+### Features
+
+* configurable network subgraph endpoint ([48c6d1c](https://github.com/graphprotocol/AllocationOpt.jl/commit/48c6d1c84b358780127052d5e05c04880101dec6))
+
 # [1.8.0](https://github.com/graphprotocol/AllocationOpt.jl/compare/v1.7.1...v1.8.0) (2022-05-24)
 
 

diff --git a/Manifest.toml b/Manifest.toml
@@ -47,12 +47,6 @@ git-tree-sha1 = "68a0743f578349ada8bc911a5cbd5a2ef6ed6d1f"
 uuid = "38540f10-b2f7-11e9-35d8-d573e4eb0ff2"
 version = "0.2.0"
 
-[[deps.Comonicon]]
-deps = ["Configurations", "ExproniconLite", "Libdl", "Logging", "Markdown", "PackageCompiler", "Pkg", "Scratch", "TOML", "UUIDs"]
-git-tree-sha1 = "1f45d06106ceb52e81a18e511578216a5ae23de4"
-uuid = "863f3e99-da2a-4334-8734-de3dacbe5542"
-version = "0.12.13"
-
 [[deps.Compat]]
 deps = ["Base64", "Dates", "DelimitedFiles", "Distributed", "InteractiveUtils", "LibGit2", "Libdl", "LinearAlgebra", "Markdown", "Mmap", "Pkg", "Printf", "REPL", "Random", "SHA", "Serialization", "SharedArrays", "Sockets", "SparseArrays", "Statistics", "Test", "UUIDs", "Unicode"]
 git-tree-sha1 = "96b0bc6c52df76506efc8a441c6cf1adcb1babc4"
@@ -63,12 +57,6 @@ version = "3.42.0"
 deps = ["Artifacts", "Libdl"]
 uuid = "e66e0078-7015-5450-92f7-15fbd957f2ae"
 
-[[deps.Configurations]]
-deps = ["ExproniconLite", "OrderedCollections", "TOML"]
-git-tree-sha1 = "ab9b7c51e8acdd20c769bccde050b5615921c533"
-uuid = "5218b696-f38b-4ac9-8b61-a12ec717816d"
-version = "0.17.3"
-
 [[deps.ConstructionBase]]
 deps = ["LinearAlgebra"]
 git-tree-sha1 = "f74e9d5388b8620b4cee35d4c5a618dd4dc547f4"
@@ -124,11 +112,6 @@ version = "0.8.6"
 deps = ["ArgTools", "LibCURL", "NetworkOptions"]
 uuid = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
 
-[[deps.ExproniconLite]]
-git-tree-sha1 = "8b08cc88844e4d01db5a2405a08e9178e19e479e"
-uuid = "55351af7-c7e9-48d6-89ff-24e801d99491"
-version = "0.6.13"
-
 [[deps.FilePathsBase]]
 deps = ["Compat", "Dates", "Mmap", "Printf", "Test", "UUIDs"]
 git-tree-sha1 = "129b104185df66e408edd6625d480b7f9e9823a0"
@@ -210,10 +193,6 @@ git-tree-sha1 = "9c43a2eb47147a8776ca2ba489f15a9f6f2906f8"
 uuid = "aa1ae85d-cabe-5617-a682-6adf51b2e16a"
 version = "0.9.11"
 
-[[deps.LazyArtifacts]]
-deps = ["Artifacts", "Pkg"]
-uuid = "4af54fe1-eca0-43a8-85a7-787d91b784e3"
-
 [[deps.LibCURL]]
 deps = ["LibCURL_jll", "MozillaCACerts_jll"]
 uuid = "b27032c2-a3e7-50c8-80cd-2d36dbcbfd21"
@@ -284,12 +263,6 @@ git-tree-sha1 = "85f8e6578bf1f9ee0d11e7bb1b1456435479d47c"
 uuid = "bac558e1-5e72-5ebc-8fee-abe8a469f55d"
 version = "1.4.1"
 
-[[deps.PackageCompiler]]
-deps = ["Artifacts", "LazyArtifacts", "Libdl", "Pkg", "Printf", "RelocatableFolders", "UUIDs"]
-git-tree-sha1 = "b2a8aef45444677037af79f060f5cb2ed48a72c4"
-uuid = "9b87118b-4619-50d2-8e1e-99f35a4d4d9d"
-version = "2.0.6"
-
 [[deps.Parsers]]
 deps = ["Dates"]
 git-tree-sha1 = "85b5da0fa43588c75bb1ff986493443f821c70b7"
@@ -318,12 +291,6 @@ uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
 deps = ["SHA", "Serialization"]
 uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 
-[[deps.RelocatableFolders]]
-deps = ["SHA", "Scratch"]
-git-tree-sha1 = "cdbd3b1338c72ce29d9584fdbe9e9b70eeb5adca"
-uuid = "05181044-ff0b-4ac5-8273-598c1e38db00"
-version = "0.1.3"
-
 [[deps.Requires]]
 deps = ["UUIDs"]
 git-tree-sha1 = "838a3a4188e2ded87a4f9f184b4b0d78a1e91cb7"
@@ -345,12 +312,6 @@ version = "1.4.0"
 [[deps.SHA]]
 uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
 
-[[deps.Scratch]]
-deps = ["Dates"]
-git-tree-sha1 = "0b4b7f1393cff97c33891da2a0bf69c6ed241fda"
-uuid = "6c6a2e73-6563-6170-7368-637461726353"
-version = "1.1.0"
-
 [[deps.SentinelArrays]]
 deps = ["Dates", "Random"]
 git-tree-sha1 = "6a2f7d70512d205ca8c7ee31bfa9f142fe74310c"

diff --git a/Project.toml b/Project.toml
@@ -1,11 +1,10 @@
 name = "AllocationOpt"
 uuid = "c8d4fa36-652a-4cad-a59b-8b946e6f88a6"
 authors = ["The Graph Foundation"]
-version = "1.8.0"
+version = "1.9.0"
 
 [deps]
 CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
-Comonicon = "863f3e99-da2a-4334-8734-de3dacbe5542"
 Debugger = "31a5f54b-26ea-5ae9-a837-f05ce5417438"
 GraphQLClient = "09d831e3-9c21-47a9-bfd8-076871817219"
 JuliaFormatter = "98e50ef6-434e-11e9-1051-2b60c6c9e899"

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -12,12 +12,6 @@ AllocationOpt is a library for optimising how an indexer should allocate its sta
 
 ## Installation
 
-1. Clone the github repository.
-
-```bash
-$ git clone [email protected]:graphprotocol/AllocationOpt.jl.git
-```
-
 1. Enter the julia repl. On linux machines, this is as simple as running the `julia` command from your terminal emulator. For MacOS, you'll need to add Julia to your path. See this [StackOverflow post](https://stackoverflow.com/questions/72123620/permission-denied-when-i-am-trying-to-add-julia-to-path-in-macos/72308646#72308646) if you're having issues.
 2. Add this package by adding the github url. First, enter package mode `]`. Then, type `add https://github.com/graphprotocol/AllocationOpt.jl`. You'll also want to add the [Comonicon package](https://github.com/comonicon/Comonicon.jl).
 
@@ -26,6 +20,10 @@ pkg> add https://github.com/graphprotocol/AllocationOpt.jl/
 pkg> add Comonicon
 ```
 
+## Public Function
+
+We expose the following functions in our public API.
+
 ```@autodocs
 Modules = [AllocationOpt]
 ```
diff --git a/docs/src/usage.md b/docs/src/usage.md
@@ -1,8 +1,13 @@
 # Usage
 
+## Configuring The Indexer Service
+
+Set indexer-service flag `--serve-network-subgraph` to `true` so optimiser can pull data from the network subgraph at the indexer-service's network endpoint.
+If you would like to keep it false, you can instead supply an API url to `indexer_service_network_url`.
+
 ## CLI Usage
 
-1. Download the [*allocationopt* script](https://raw.githubusercontent.com/graphprotocol/AllocationOpt.jl/main/scripts/allocationopt). For example, using `curl` or `wget`.
+1. Download the [*allocationopt* script](https://raw.githubusercontent.com/graphprotocol/AllocationOpt.jl/main/scripts/allocationopt). For example, using `curl` or `wget`. Make sure you use the raw file!
 2. Make the *allocationopt* script executable.
 
 ```bash