You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -32,78 +32,4 @@ Maintainers are assigned the following scopes in this repository:
32
32
33
33
## The Duties of a Maintainer
34
34
35
-
Maintainers are expected to perform the following duties for this repository. The duties are listed in more or less priority order:
36
-
37
-
- Review, respond, and act on any security vulnerabilities reported against the repository.
38
-
- Review, provide feedback on, and merge or reject GitHub Pull Requests from
39
-
Contributors.
40
-
- Review, triage, comment on, and close GitHub Issues
41
-
submitted by Contributors.
42
-
- When appropriate, lead/facilitate architectural discussions in the community.
43
-
- When appropriate, lead/facilitate the creation of a product roadmap.
44
-
- Create, clarify, and label issues to be worked on by Contributors.
45
-
- Ensure that there is a well defined (and ideally automated) product test and
46
-
release pipeline, including the publication of release artifacts.
47
-
- When appropriate, execute the product release process.
48
-
- Maintain the repository CONTRIBUTING.md file and getting started documents to
49
-
give guidance and encouragement to those wanting to contribute to the product, and those wanting to become maintainers.
50
-
- Contribute to the product via GitHub Pull Requests.
51
-
- Monitor requests from the LF Decentralized Trust Technical Advisory Council about the
52
-
contents and management of LFDT repositories, such as branch handling,
53
-
required files in repositories and so on.
54
-
- Contribute to the LFDT Project's Quarterly Report.
55
-
56
-
## Becoming a Maintainer
57
-
58
-
This community welcomes contributions. Interested contributors are encouraged to
59
-
progress to become maintainers. To become a maintainer the following steps
60
-
occur, roughly in order.
61
-
62
-
- The proposed maintainer establishes their reputation in the community,
63
-
including authoring five (5) significant merged pull requests, and expresses
64
-
an interest in becoming a maintainer for the repository.
65
-
- A PR is created to update this file to add the proposed maintainer to the list of active maintainers.
66
-
- The PR is authored by an existing maintainer or has a comment on the PR from an existing maintainer supporting the proposal.
67
-
- The PR is authored by the proposed maintainer or has a comment on the PR from the proposed maintainer confirming their interest in being a maintainer.
68
-
- The PR or comment from the proposed maintainer must include their
69
-
willingness to be a long-term (more than 6 month) maintainer.
70
-
- Once the PR and necessary comments have been received, an approval timeframe begins.
71
-
- The PR **MUST** be communicated on all appropriate communication channels, including relevant community calls, chat channels and mailing lists. Comments of support from the community are welcome.
72
-
- The PR is merged and the proposed maintainer becomes a maintainer if either:
73
-
- Two weeks have passed since at least three (3) Maintainer PR approvals have been recorded, OR
74
-
- An absolute majority of maintainers have approved the PR.
75
-
- If the PR does not get the requisite PR approvals, it may be closed.
76
-
- Once the add maintainer PR has been merged, any necessary updates to the GitHub Teams are made.
77
-
78
-
## Removing Maintainers
79
-
80
-
Being a maintainer is not a status symbol or a title to be carried
81
-
indefinitely. It will occasionally be necessary and appropriate to move a
82
-
maintainer to emeritus status. This can occur in the following situations:
83
-
84
-
- Resignation of a maintainer.
85
-
- Violation of the Code of Conduct warranting removal.
86
-
- Inactivity.
87
-
- A general measure of inactivity will be no commits or code review comments
88
-
for one reporting quarter. This will not be strictly enforced if
89
-
the maintainer expresses a reasonable intent to continue contributing.
90
-
- Reasonable exceptions to inactivity will be granted for known long term
91
-
leave such as parental leave and medical leave.
92
-
- Other circumstances at the discretion of the other Maintainers.
93
-
94
-
The process to move a maintainer from active to emeritus status is comparable to the process for adding a maintainer, outlined above. In the case of voluntary
95
-
resignation, the Pull Request can be merged following a maintainer PR approval. If the removal is for any other reason, the following steps **SHOULD** be followed:
96
-
97
-
- A PR is created to update this file to move the maintainer to the list of emeritus maintainers.
98
-
- The PR is authored by, or has a comment supporting the proposal from, an existing maintainer or a member of the project's Technical Steering Commitee (TSC).
99
-
- Once the PR and necessary comments have been received, the approval timeframe begins.
100
-
- The PR **MAY** be communicated on appropriate communication channels, including relevant community calls, chat channels and mailing lists.
101
-
- The PR is merged and the maintainer transitions to maintainer emeritus if:
102
-
- The PR is approved by the maintainer to be transitioned, OR
103
-
- Two weeks have passed since at least three (3) Maintainer PR approvals have been recorded, OR
104
-
- An absolute majority of maintainers have approved the PR.
105
-
- If the PR does not get the requisite PR approvals, it may be closed.
106
-
107
-
Returning to active status from emeritus status uses the same steps as adding a
108
-
new maintainer. Note that the emeritus maintainer already has the 5 required
109
-
significant changes as there is no contribution time horizon for those.
35
+
Maintainers are expected to perform duties in alignment with **[Hiero-Ledger's defined maintainer guidelines](https://github.com/hiero-ledger/governance/blob/main/roles-and-groups.md#maintainers).**
|`CHAIN_ID`|`0x12a`| The network chain id. Local and previewnet envs should use `0x12a` (298). Previewnet, Testnet and Mainnet should use `0x129` (297), `0x128` (296) and `0x127` (295) respectively |
86
-
|`HEDERA_NETWORK`| `` | Which network to connect to. Automatically populates the main node & mirror node endpoints. Can be `MAINNET`, `PREVIEWNET`, `TESTNET` or `OTHER`|
|`CHAIN_ID`|`0x12a`| The network chain id. Local and previewnet envs should use `0x12a` (298). Previewnet, Testnet and Mainnet should use `0x129` (297), `0x128` (296) and `0x127` (295) respectively |
86
+
|`HEDERA_NETWORK`| `` | Which network to connect to. Automatically populates the main node & mirror node endpoints. Can be `MAINNET`, `PREVIEWNET`, `TESTNET` or `OTHER`|
87
87
|`MIRROR_NODE_URL`| `` | The Mirror Node API endpoint. Official endpoints are Previewnet (https://previewnet.mirrornode.hedera.com), Testnet (https://testnet.mirrornode.hedera.com), Mainnet (https://mainnet-public.mirrornode.hedera.com). See [Mirror Node REST API](https://docs.hedera.com/hedera/sdks-and-apis/rest-api)|
88
88
89
89
#### Run
@@ -258,17 +258,19 @@ The hedera-json-rpc-relay ships with a metrics endpoint at `/metrics`. Here is a
258
258
Please note that the `/metrics` endpoint is also a default scrape configurations for prometheus. The `job_name` of `kubernetes-pods` is generally deployed as a default with prometheus; in the case where this scrape_config is present metrics will start getting populated by that scrape_config and no other configurations are necessary.
259
259
260
260
##### Dashboard
261
+
261
262
[Grafana JSON Dashboards](https://github.com/hiero-ledger/hiero-json-rpc-relay/tree/main/charts/hedera-json-rpc-relay/dashboards) can be used as the dashboard for hedera-json-rpc-relay.
262
263
263
264
##### Admin-specific RPC methods
264
265
265
266
- GET `/config` - To provide more transparency and operational insight to the developers, the hiero-json-rpc-relay exposes all environment variables. Such information could aid in troubleshooting and understanding the context in which the relay is running.
Copy file name to clipboardExpand all lines: docs/configuration.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -88,6 +88,7 @@ Unless you need to set a non-default value, it is recommended to only populate o
88
88
|`MIRROR_NODE_URL_HEADER_X_API_KEY`| "" | Authentication for a `MIRROR_NODE_URL` that requires authentication via the `x-api-key` header. |
89
89
|`MULTI_SET`| "false" | Switch between different implementation of setting multiple K/V pairs in the shared cache. True is mSet, false is pipeline |
90
90
|`JUMBO_TX_ENABLED`| "true" | Controls how large transactions are handled during `eth_sendRawTransaction`. When set to `true`, transactions up to 128KB can be sent directly to consensus nodes without using Hedera File Service (HFS), as long as contract bytecode doesn't exceed 24KB. When set to `false`, all transactions containing contract deployments use the traditional HFS approach. This feature leverages the increased transaction size limit to simplify processing of standard Ethereum transactions. |
91
+
|`IP_RATE_LIMIT_STORE`| null | Specifies the rate limit store to use for IP-based rate limiting: valid values are "LRU", "REDIS", with the possibility to be extended with a custom implementation (see [Store Selection](rate-limiting.md#store-selection)). If unset, falls back to Redis when `REDIS_ENABLED=true`, otherwise uses in-memory LRU. |
91
92
|`REDIS_ENABLED`| "true" | Enable usage of Redis as shared cache |
92
93
|`REDIS_RECONNECT_DELAY_MS`| "1000" | Sets the delay between reconnect retries from the Redis client in ms |
93
94
|`REDIS_URL`| "redis://127.0.0.1:6379" | Sets the url for the Redis shared cache |
Copy file name to clipboardExpand all lines: docs/openrpc.json
+9-1Lines changed: 9 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
"info": {
4
4
"title": "Hedera JSON-RPC Specification",
5
5
"description": "A specification of the implemented Ethereum JSON RPC APIs interface for Hedera clients and adheres to the Ethereum execution APIs schema.",
0 commit comments