Merge pull request #52 from ssvlabs/sdk-and-subgraph-fixes

New SDK initialization

Author: RaekwonIII

docs/based-applications/developers/BA-SDK/README.md

@@ -39,6 +39,9 @@ npm i @ssv-labs/bapps-sdk
 
 ## Example Usage
 
+The `extendedConfig` parameter in th `BasedAppsSDK` constructor is optional, if not provided, the SDK will use the development endpoint. Bear in mind that this is rate limited, though, so it is strongly advised to use an API key with the free plan.
+For more information regarding your subgraph API key, please refer to the [dedicated Subgraph page](../subgraph.md#based-application-subgraph).
+
 ```typescript
 import { BasedAppsSDK } from "@ssv-labs/bapps-sdk";
 import { createPublicClient, createWalletClient, http } from 'viem'
@@ -64,6 +67,11 @@ const sdk = new BasedAppsSDK({
    beaconchainUrl: 'https://example.com/beacon',
    publicClient,
    walletClient,
+   extendedConfig: {
+    subgraph: {
+      apiKey: "<YOUR_SUBGRAPH_API_KEY>"
+    }
+  }
  })
 
 async function main(): Promise<void> {

docs/based-applications/developers/smart-contracts/README.md

@@ -22,10 +22,10 @@ This smart contract is under development and as such, it is only deployed on the
 #### Hoodi Testnet
 | Contract        | Address                                                                                                      |
 |-----------------|-------------------------------------------------------------------------------------------------------------|
-| SSVBasedApps       | [`0x3F2983b813054Eba76Ae137DfA77836CA8b00ACE`](https://hoodi.etherscan.io/address/0x3F2983b813054Eba76Ae137DfA77836CA8b00ACE) |
+| SSVBasedApps       | [`0xc7fCFeEc5FB9962bDC2234A7a25dCec739e27f9f`](https://hoodi.etherscan.io/address/0xc7fCFeEc5FB9962bDC2234A7a25dCec739e27f9f) |
 
 
 #### ABI
 
 <!-- TODO missing ABI -->
-* [Testnet](https://github.com/ssvlabs/based-applications/tree/contract-abi/docs/testnet/v1.1.0/abi)
+* [Testnet](https://github.com/ssvlabs/based-applications/tree/contract-abi/docs/prod/v0.1.0)

docs/based-applications/developers/subgraph.md

@@ -6,13 +6,50 @@ sidebar_position: 4
 
 # Based Application Subgraph
 
+The Graph is a decentralized indexing protocol for the Ethereum (and other EVM-compatible) blockchains. It allows to process data produced by smart contracts and apply logic to it, making it easier and faster to query.
+
+The Graph can be used for querying data related to the SSV protocol and develop applications on top of it.
+
+:::info
+### New to GraphQL?
+
+Before diving into subgraph queries, get familiar with GraphQL basics: [Learn GraphQL](https://graphql.org/learn/)
+:::
+
+A Subgraph that implements the necessary logic to index all the events emitted by the SSV smart contract has been developed, and the code is open source, you can [find it here](https://github.com/ssvlabs/ssv-subgraph).
+
 All of the data for a based application is stored in the Based Application Subgraph.
 
-## Querying the Subgraph
+## Querying SSV Protocol smart contract data
+
+Currently, only the [Hoodi Testnet](https://thegraph.com/explorer/subgraphs/F4AU5vPCuKfHvnLsusibxJEiTN7ELCoYTvnzg3YHGYbh?view=Query&chain=arbitrum-one) subgraph has Based Applications data, as Based Applications are currently still on testnet phase.
+
+There are a few ways to access smart contract data through The Graph.
+
+### Subgraph Playground user interface
+
+First of all, you can access the Subgraph page on the Graph Explorer, and use it to experiment and prototype queries using the provided Playground.
+
+![Subgraph Playground](/img/subgraph-1.png)
+
+It's possible to access the underlying GraphQL schema, by clicking the _folder icon_ on the right of the playground. This is self-documenting, similarly (and more) to Swagger for a RESTful API, but it's also more powerful, since it will allow you to build queries through simple point-and-click interactions.
+
+Once you are satisfied with the query you built, click on the _Play_ button in the center to launch it and obtain the result.
+
+![Subgraph Playground](/img/subgraph-2.png)
+
+
+Further documentation about the schema can be accessed by clicking on the _book icon_ on the right of the Playground window.
+
+### Query API
+
+The screenshot below shows the lower section of the _Query_ page.
+
+![Subgraph Playground](/img/subgraph-3.png)
 
-The subgraph can be queried at this API for holesky: `https://api.studio.thegraph.com/query/71118/based-applications-ssv-holesky/version/latest`
+It provides instructions on how to query this subgraph programmatically, using the public endpoint and an API-key. You can generate your own API key by visiting the [Subgraph Studio page](https://thegraph.com/studio/apikeys/), and selecting API Keys at the top. The free plan allows 100 thousand queries per month, which should be plenty for your development needs.
 
-**Subgraphs for Hoodi will be available soon.**
+Delving deeper into programmatically querying the endpoint: in order do this, you would need to know exactly the query you want to perform, and then perform a `POST` request to the provided endpoint, adding the API key as a header to the request.
 
 ## Example Queries
 

docs/developers/SSV-SDK/README.md

@@ -60,9 +60,17 @@ const walletClient = createWalletClient({
 const sdk = new SSVSDK({
   publicClient,
   walletClient,
+  extendedConfig: {
+    subgraph: {
+      apiKey: "<YOUR_SUBGRAPH_API_KEY>"
+    }
+  }
 })
 ```
 
+The `extendedConfig` parameter is optional, if not provided, the SDK will use the development endpoint. Bear in mind that this is rate limited, though, so it is strongly advised to use an API key with the free plan.
+For more information regarding your subgraph API key, please refer to the [dedicated Subgraph page](../tools/ssv-subgraph/README.md).
+
 ### Initialization Parameters
 
 | Input name | Input type | Optional |

docs/developers/tools/ssv-subgraph/README.md

@@ -23,63 +23,31 @@ A series of examples of the most useful queries and the data accessible via the
 
 ## Querying SSV Protocol smart contract data
 
-Currently, there are two official Subgraphs deployed, one for [Ethereum Mainnet](https://thegraph.com/explorer/subgraphs/7V45fKPugp9psQjgrGsfif98gWzCyC6ChN7CW98VyQnr?view=Playground\&chain=arbitrum-one)
-
-**Explorer for Hoodi will be available soon.**
+Currently, there are two official Subgraphs deployed, one for [Ethereum Mainnet](https://thegraph.com/explorer/subgraphs/7V45fKPugp9psQjgrGsfif98gWzCyC6ChN7CW98VyQnr?view=Playground\&chain=arbitrum-one) and one for the [Hoodi Testnet](https://thegraph.com/explorer/subgraphs/F4AU5vPCuKfHvnLsusibxJEiTN7ELCoYTvnzg3YHGYbh?view=Query&chain=arbitrum-one)
 
 There are a few ways to access SSV smart contract data through The Graph.
 
 ### Subgraph Playground user interface
 
 First of all, you can access the Subgraph page on the Graph Explorer, and use it to experiment and prototype queries using the provided Playground.
 
-![Subgraph Playground](/img/subgraph-1.avif)
+![Subgraph Playground](/img/subgraph-1.png)
 
 It's possible to access the underlying GraphQL schema, by clicking the _folder icon_ on the right of the playground. This is self-documenting, similarly (and more) to Swagger for a RESTful API, but it's also more powerful, since it will allow you to build queries through simple point-and-click interactions.
 
 Once you are satisfied with the query you built, click on the _Play_ button in the center to launch it and obtain the result.
 
-![Subgraph Playground](/img/subgraph-2.avif)
+![Subgraph Playground](/img/subgraph-2.png)
 
 
 Further documentation about the schema can be accessed by clicking on the _book icon_ on the right of the Playground window.
 
-### Developer API
-
-:::info
-The developer API is rate limited and should only be used for infrequent queries that are not data heavy, like a single owner nonce, or the cluster snapshot information for a single cluster.
-:::
-
-The developer API is typically not publicly accessed, but it is provided below, to foster development of applications built on the SSV protocol. Here are the Developer endpoints for the two deployed Subgraphs:
-
-#### Developer API for Ethereum Mainnet SSV Subgraph
-
-```
-https://api.studio.thegraph.com/query/71118/ssv-network-ethereum/version/latest
-```
-
-#### Developer API for Hoodi testnet SSV Subgraph
-
-```
-https://api.studio.thegraph.com/query/71118/ssv-network-hoodi/version/latest
-```
-
-Despite being rate limited, this endpoint should be sufficient for every development use case.
-
-In order to use it, you would need to know exactly the query you want to perform, and then perform a `POST` request to the provided endpoint.
-
-Furthermore, a simple project aimed at providing an example of how to use the subgraph to substitute the [`ssv-scanner`](/developers/tools/ssv-scanner) tool can be found in this repository: [SSV Scanner Demo Repository](https://github.com/raekwonIII/ssv-scanner-demo)
-
-### Production API
-
-As previously mentioned, the Developer API is accessible to anyone for free, but it's rate limited. As such, it should be used for sporadic, light requests.
-
-For demanding and very frequent requests, you should be using the Production API, for which the data is provided by decentralized indexers, who get rewarded by the protocol tokenomics for providing the service.
+### Query API
 
-In order to use this endpoint, head over to the Subgraph's page and click on the _Query_ button.
+The screenshot below shows the lower section of the _Query_ page.
 
-![Subgraph Playground](/img/subgraph-3.avif)
+![Subgraph Playground](/img/subgraph-3.png)
 
-As you can see, the provided URL requires an API key, follow the documentation in the page, to find out how to create one.
+It provides instructions on how to query this subgraph programmatically, using the public endpoint and an API-key. You can generate your own API key by visiting the [Subgraph Studio page](https://thegraph.com/studio/apikeys/), and selecting API Keys at the top. The free plan allows 100 thousand queries per month, which should be plenty for your development needs.
 
-Once you have obtained your API key, you can essentially follow the instructions in the previous section, only substituting the URL in the examples with your new endpoint.
+Delving deeper into programmatically querying the endpoint: in order do this, you would need to know exactly the query you want to perform, and then perform a `POST` request to the provided endpoint, adding the API key as a header to the request.