Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Improve multiple endpoints configuration

オープン
#1,925 コメント 0 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
typescript

調査の方向性

Begin by locating the existing endpoint representation in project manifests and CLI flag parsing, then trace how endpoint values flow into project execution. Define the backward-compatible configuration shape and verify CLI JSON input and config-file runs; done means headers, rate limits, weighting, batch size, and retries work without breaking existing strings or arrays.

索引モデルが issue の本文から書いたものです。

説明

crucial New Feature
Description

Currently specifying endpoints is fairly limited. We can only specify a string for each one. But there are many use cases where you would want to have more control over these endpoints. This could include weighting them, specifying headers or rate limiting options.

Different api providers have different ways of providing api keys and other authentication. Currently the only way to do this is with path params and we convert them to headers. This is not very flexible and can lead to logging leaking api keys.

It is nearly impossible to determine the rate limit for an endpoint, being able to specify this will allow for optimal indexing speeds given a rate limited endpoint.

Requirements
  • Be backwards compatible with current flags and project manifests
  • Introduce a new data structure to specify endpoints details (this is a rough example):
type EndpointConfig = {
  headers?: Record<string, unknown>;
  rateLimit?: { requests: number, interval: 'second' | 'minute' | 'hour' };
  weighting: number; // TBD, this should allow users to specify a primary endpoint that gets used over other endpoints
  batchSize?: number; // JSON RPC batch size, where applicable (ethereum)
  retries?: number; // Number of retries this endpoint will make before throwing. Default 1.
}
  • Allow specifying a default EndpointConfig that applies to all endpoints

Manifests network endpoint would then have the following type string | string[] | Record<string, EndpointConfig>

  • CLI flags should accept json strings for this new functionality.
  • We should ensure that running a project from a config file works with this feature.
主要言語
TypeScript
スター
18.7k
フォーク
396
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

subquery/subql のほかの issue

subquery/subql の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。