@sablier/indexers 1.1.1 → 1.3.0-beta.0

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.
Files changed (45) hide show
  1. package/README.md +8 -43
  2. package/dist/experimental.d.ts +1 -1
  3. package/dist/experimental.d.ts.map +1 -1
  4. package/dist/experimental.js +2 -2
  5. package/dist/experimental.js.map +1 -1
  6. package/dist/gql/airdrops/envio/graphql.d.ts +619 -1614
  7. package/dist/gql/airdrops/envio/graphql.d.ts.map +1 -1
  8. package/dist/gql/airdrops/envio/graphql.js +16 -157
  9. package/dist/gql/airdrops/envio/graphql.js.map +1 -1
  10. package/dist/gql/airdrops/graph/graphql.d.ts +27 -0
  11. package/dist/gql/airdrops/graph/graphql.d.ts.map +1 -1
  12. package/dist/gql/airdrops/graph/graphql.js +7 -0
  13. package/dist/gql/airdrops/graph/graphql.js.map +1 -1
  14. package/dist/gql/flow/envio/graphql.d.ts +639 -1540
  15. package/dist/gql/flow/envio/graphql.d.ts.map +1 -1
  16. package/dist/gql/flow/envio/graphql.js +31 -155
  17. package/dist/gql/flow/envio/graphql.js.map +1 -1
  18. package/dist/gql/flow/graph/graphql.d.ts +216 -0
  19. package/dist/gql/flow/graph/graphql.d.ts.map +1 -1
  20. package/dist/gql/flow/graph/graphql.js +18 -1
  21. package/dist/gql/flow/graph/graphql.js.map +1 -1
  22. package/dist/gql/lockup/envio/graphql.d.ts +636 -1551
  23. package/dist/gql/lockup/envio/graphql.d.ts.map +1 -1
  24. package/dist/gql/lockup/envio/graphql.js +31 -158
  25. package/dist/gql/lockup/envio/graphql.js.map +1 -1
  26. package/dist/gql/lockup/graph/graphql.d.ts +216 -0
  27. package/dist/gql/lockup/graph/graphql.d.ts.map +1 -1
  28. package/dist/gql/lockup/graph/graphql.js +18 -1
  29. package/dist/gql/lockup/graph/graphql.js.map +1 -1
  30. package/dist/indexers/envio.d.ts +1 -1
  31. package/dist/indexers/envio.d.ts.map +1 -1
  32. package/dist/indexers/envio.js +0 -3
  33. package/dist/indexers/envio.js.map +1 -1
  34. package/dist/indexers/graph.d.ts.map +1 -1
  35. package/dist/indexers/graph.js +5 -13
  36. package/dist/indexers/graph.js.map +1 -1
  37. package/dist/queries/airdrops/envio.d.ts.map +1 -1
  38. package/dist/queries/airdrops/graph.d.ts.map +1 -1
  39. package/dist/queries/flow/envio.d.ts.map +1 -1
  40. package/dist/queries/flow/graph.d.ts.map +1 -1
  41. package/dist/queries/lockup/envio.d.ts.map +1 -1
  42. package/dist/queries/lockup/graph.d.ts.map +1 -1
  43. package/dist/types.d.ts +1 -0
  44. package/dist/types.d.ts.map +1 -1
  45. package/package.json +13 -5
package/README.md CHANGED
@@ -24,58 +24,23 @@ indexer for each protocol:
24
24
  - [Sablier Flow](https://docs.sablier.com/api/flow/indexers) - Payment streams data
25
25
  - [Sablier Lockup](https://docs.sablier.com/api/lockup/indexers) - Vesting streams data
26
26
 
27
- ## Deployments 🚀
27
+ ## Quickstart 🚀
28
28
 
29
- ### Envio
29
+ Query the Envio GraphQL endpoints directly to access Sablier protocol data:
30
30
 
31
- Sync the changes to the `deployment/main` branch, and the Envio Hosted Service will automatically build and deploy the
32
- new indexers.
31
+ - **Airdrops**: `https://indexer.hyperindex.xyz/508d217/v1/graphql`
32
+ - **Flow**: `https://indexer.hyperindex.xyz/3b4ea6b/v1/graphql`
33
+ - **Lockup**: `https://indexer.hyperindex.xyz/53b7e25/v1/graphql`
33
34
 
34
- ### The Graph
35
-
36
- #### Version Label
37
-
38
- Each subgraph has a version label used to track changes made to the subgraph. The format is:
39
-
40
- ```text
41
- v{PROTOCOL_VERSION}--v{SUBGRAPH_VERSION}
42
- ```
43
-
44
- Here's an example for how to set the version label if the current version label is `v2.0--v1.0.0`:
45
-
46
- | Change | New Version Label |
47
- | -------------------- | --------------------- |
48
- | Hot fix | `v2.0--v1.0.1` |
49
- | New addresses | `v2.0--v1.1.0` |
50
- | Staging | `v2.1--v1.0.0-beta.0` |
51
- | New protocol release | `v2.1--v1.0.0` |
52
-
53
- For a full list of protocol versions, see the [Sablier SDK](https://github.com/sablier-labs/sdk) (run the
54
- `print-versions` command).
55
-
56
- #### Scripts
57
-
58
- Go to each protocol's directory and run the `deploy-all` recipe. For example:
59
-
60
- ```shell
61
- cd graph/lockup
62
- just deploy-all v2.1--v1.0.0
63
- ```
64
-
65
- Then, do the same for the other protocols.
66
-
67
- > [!NOTE]
68
- >
69
- > The Graph is not officially supported on some chains, e.g. Lightlink. To make deployments to these custom instances of
70
- > The Graph, use the `deploy-custom` recipe.
35
+ For detailed documentation, queries, and examples, visit our [API docs](https://docs.sablier.com/api/overview).
71
36
 
72
37
  ## Contributing 🤝
73
38
 
74
- We welcome contributions! [Open an issue](https://github.com/sablier-labs/indexers/ issues/new),
39
+ We welcome contributions! [Open an issue](https://github.com/sablier-labs/indexers/issues/new),
75
40
  [start a discussion](https://github.com/sablier-labs/indexers/discussions/new), or submit a PR.
76
41
 
77
42
  Read our [CONTRIBUTING](./CONTRIBUTING.md) guide to get started. Join our [Discord server][discord] for questions and
78
- feedback. Join our [Discord server][discord] for questions and feedback.
43
+ feedback.
79
44
 
80
45
  ## License 📄
81
46
 
@@ -1,4 +1,4 @@
1
- import type { Indexer } from ".";
1
+ import type { Indexer } from "./types";
2
2
  export declare function getExperimentalURL(opts: {
3
3
  protocol: Indexer.Protocol;
4
4
  vendor: Indexer.Vendor;
@@ -1 +1 @@
1
- {"version":3,"file":"experimental.d.ts","sourceRoot":"","sources":["../src/experimental.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,GAAG,CAAC;AAMjC,wBAAgB,kBAAkB,CAAC,IAAI,EAAE;IAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC;IAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAA;CAAE,GAAG,MAAM,CAgBvG"}
1
+ {"version":3,"file":"experimental.d.ts","sourceRoot":"","sources":["../src/experimental.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAKvC,wBAAgB,kBAAkB,CAAC,IAAI,EAAE;IAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC;IAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAA;CAAE,GAAG,MAAM,CAgBvG"}
@@ -2,7 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.getExperimentalURL = getExperimentalURL;
4
4
  const chains_1 = require("sablier/dist/chains");
5
- const _1 = require(".");
5
+ const getters_1 = require("./indexers/getters");
6
6
  function getExperimentalURL(opts) {
7
7
  const { protocol, vendor } = opts;
8
8
  if (vendor === "envio") {
@@ -13,7 +13,7 @@ function getExperimentalURL(opts) {
13
13
  };
14
14
  return `https://indexer.hyperindex.xyz/${id[protocol]}/v1/graphql`;
15
15
  }
16
- const indexer = (0, _1.getIndexer)({ chainId: chains_1.sepolia.id, protocol, vendor: "graph" });
16
+ const indexer = (0, getters_1.getIndexer)({ chainId: chains_1.sepolia.id, protocol, vendor: "graph" });
17
17
  if (!indexer?.testingURL) {
18
18
  throw new Error(`Sepolia Indexer not found for protocol ${protocol}`);
19
19
  }
@@ -1 +1 @@
1
- {"version":3,"file":"experimental.js","sourceRoot":"","sources":["../src/experimental.ts"],"names":[],"mappings":";;AAkBA,gDAgBC;AAvBD,gDAA8C;AAE9C,wBAA+B;AAK/B,SAAgB,kBAAkB,CAAC,IAA4D;IAC7F,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAClC,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;QACvB,MAAM,EAAE,GAAG;YACT,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,SAAS;YACf,MAAM,EAAE,SAAS;SAClB,CAAC;QACF,OAAO,kCAAkC,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC;IACrE,CAAC;IAED,MAAM,OAAO,GAAG,IAAA,aAAU,EAAC,EAAE,OAAO,EAAE,gBAAO,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;IAC/E,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,0CAA0C,QAAQ,EAAE,CAAC,CAAC;IACxE,CAAC;IACD,OAAO,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;AAC/D,CAAC"}
1
+ {"version":3,"file":"experimental.js","sourceRoot":"","sources":["../src/experimental.ts"],"names":[],"mappings":";;AAkBA,gDAgBC;AAvBD,gDAA8C;AAC9C,gDAAgD;AAMhD,SAAgB,kBAAkB,CAAC,IAA4D;IAC7F,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAClC,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;QACvB,MAAM,EAAE,GAAG;YACT,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,SAAS;YACf,MAAM,EAAE,SAAS;SAClB,CAAC;QACF,OAAO,kCAAkC,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC;IACrE,CAAC;IAED,MAAM,OAAO,GAAG,IAAA,oBAAU,EAAC,EAAE,OAAO,EAAE,gBAAO,CAAC,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;IAC/E,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,0CAA0C,QAAQ,EAAE,CAAC,CAAC;IACxE,CAAC;IACD,OAAO,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;AAC/D,CAAC"}