More
Frequently asked questions
Collection of frequently (and not-so-frequently) asked questions.
Subgraphs
Do my subgraph requests need to be authenticated?
Do my subgraph requests need to be authenticated?
Endpoints are by default publicly accessible but you can make your endpoints
private so that it’s only accessible by authenticated users, see private
endpoints. Regardless of the access type,
endpoints are typically rate-limited preventing abuse, and are not publicly
indexed or searchable. As a best practice, you may want to proxy your
requests to prevent leaking your endpoint URL from your front-end.
A subgraph I deployed instantly synced to 100%. Is that an error?
A subgraph I deployed instantly synced to 100%. Is that an error?
No! If Goldsky has already indexed that subgraph (unique subgraphs
identified by their IPFS hash), it will sync instantly, though you will be
provided your own endpoint with your own rate limits applied. Query away.
How many requests can Goldsky handle on an subgraph endpoint?
How many requests can Goldsky handle on an subgraph endpoint?
By default, the Scale plan is restricted to 50 requests every 10 seconds.
However, our Enterprise plans scale horizontally and our highest-use
endpoints are seamlessly handling thousands of requests a second at peak. If
you need a higher rate limit than what you have enabled on your account,
please contact us!
Do Goldsky subgraphs support subscriptions?
Do Goldsky subgraphs support subscriptions?
Not at the moment, though similar functionality for “live queries” can be
accomplished by polling our querying endpoints. We also do support webhooks,
which can be similarly useful for certain push-based use cases.
I keep getting 524 errors with instant subgraphs, what is wrong?
I keep getting 524 errors with instant subgraphs, what is wrong?
Deployments with a lot of metadata can sometimes time out the IPFS server.
You can try again (right away, and if that isn’t working, a bit later) and
eventually one attempt should work. This is a limitation of the IPFS server,
but we’re exploring options to workaround this. If you continue to face
issues, contact our support team at
support@goldsky.com and we’ll help manually
port it over.
I am getting a 'store error' issue, how do I fix it?
I am getting a 'store error' issue, how do I fix it?
You may get
store error: column "x" specified more than once when using
Goldsky’s Instant Subgraphs
functionality. Multiple ABIs
might be causing name conflicts due to conflicting fields or event names in
the ABI. You can try splitting multiple ABIs into multiple subgraphs. There
will be a mitigation for this in a future version. If you run into issues
deploying or with the subgraph separately, contact our support team at
support@goldsky.com.Mirror
What region(s) is data sent from?
What region(s) is data sent from?
Mirror pipelines write data from
us-west-2 on AWS from a dynamic range of IP addresses. If you need VPC peering / static IPs for your allow list, contact us at support@goldsky.com to discuss your use case.Can I set a resource size while creating a pipeline?
Can I set a resource size while creating a pipeline?
Yes! Add
--resource size <size> to your goldsky pipeline create <name> command, and the resource size will be set prior to deployment of the pipeline, preventing the need for a pipeline update (which restarts the resource).Can a pipeline write to a sink with past data from a previous pipeline?
Can a pipeline write to a sink with past data from a previous pipeline?
Yes - if the primary key is the same (which is the default), the pipeline will upsert and not rewrite data. If it’s already there (based on the primary key) it will skip and move to the next record until it identifies data that isn’t already in the destination sink. It’s important to note that this only applies for databases that support upserts, such as Postgres, MySQL, and Elasticsearch. This does not work on S3, and duplicate data is written.
How big is each dataset?
How big is each dataset?
Your destination sink and indexes kept will vastly influence how much storage you need for your data. We are working on publishing a record count for raw data tables to serve as a starting point for approximation, but in the meantime feel free to contact support for a better estimate for your specific use case!
Platform
How does Goldsky secure my project API keys?
How does Goldsky secure my project API keys?
API keys are only kept hashed (meaning after it’s displayed for the first
time, you need to copy and save it locally in order to access it, we won’t
be able to restore it for you!). If your API key is lost, you can reset /
generate a new one from the settings page in the web app.
Can I use Goldsky on my custom chain or rollup?
Can I use Goldsky on my custom chain or rollup?
Goldsky can support any EVM-compatible chain. If we don’t support it in our
shared indexing infrastructure, contact us to get set up with a dedicated
indexer. Once set up, we can add new chains to your instance in about an
hour turnaround time or less.
Are different versions of the same subgraph charged separately?
Are different versions of the same subgraph charged separately?
Yes, every version of a subgraph incurs a separate worker fee and storage
(in terms of entities) is also counted separately. Be sure to delete old
versions of a subgraph you no longer need to query to minimize wasteful
spend.
Other
I have a question not addressed here, can you help?
I have a question not addressed here, can you help?
For help with anything else not answered on this documentation page, feel free
to try the doc-wide search with the top-bar, and if that doesn’t help you find
what you’re looking for, don’t hesitate to contact our support team at
support@goldsky.com.