-
Notifications
You must be signed in to change notification settings - Fork 1
feat: Use tags for chains in OpenRPC specs #229
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
stanleyjones
wants to merge
1
commit into
main
Choose a base branch
from
sj/core-api-tags
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
title: Core API Quickstart | ||
description: Get started building on the Alchemy Core JSON-RPC API | ||
subtitle: Get started building on the Alchemy Core JSON-RPC API | ||
slug: reference/core-api-quickstart | ||
--- | ||
|
||
## Introduction | ||
|
||
Hi. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
api: | ||
specs: | ||
- openrpc: ../../../build/api-specs/alchemy/json-rpc/core-api.json |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -58,5 +58,6 @@ | |
"remark-preset-lint-recommended": "^7.0.1", | ||
"typescript": "^5.8.3", | ||
"typescript-eslint": "^8.31.0" | ||
} | ||
}, | ||
"packageManager": "[email protected]+sha1.64838798f519c18029c1e8a1310e16101fc2eda0" | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
info: | ||
title: Alchemy Core API JSON-RPC Specification | ||
description: A specification of the standard JSON-RPC methods for Core API. | ||
version: 0.0.0 | ||
servers: | ||
[ | ||
{ "url": "https://eth-mainnet.g.alchemy.com/v2", "name": "Mainnet" }, | ||
{ "url": "https://eth-holesky.g.alchemy.com/v2", "name": "Holesky" }, | ||
{ | ||
"url": "https://opt-mainnet.g.alchemy.com/v2", | ||
"name": "Optimism Mainnet", | ||
}, | ||
{ | ||
"url": "https://opt-sepolia.g.alchemy.com/v2", | ||
"name": "Optimism Sepolia", | ||
}, | ||
] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
- name: eth_blockNumber | ||
tags: | ||
- name: "Ethereum" | ||
description: "Ethereum Methods" | ||
- name: "Optimism" | ||
description: "Optimism Methods" | ||
Comment on lines
+2
to
+6
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Would prefer to do it this way (although with |
||
description: Returns the number of the most recent block. | ||
params: [] | ||
result: | ||
name: Block number | ||
description: The block number of the most recently mined block as a hexadecimal string. | ||
schema: | ||
$ref: "#/components/schemas/uint" | ||
examples: | ||
- name: eth_blockNumber example | ||
params: [] | ||
result: | ||
name: Block number | ||
value: "0x2377" |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This works but includes all of the methods in the API spec, not just the ones that we tagged "Ethereum" or "Optimism".