diff --git a/build/api-specs/alchemy/json-rpc/core-api.json b/build/api-specs/alchemy/json-rpc/core-api.json new file mode 100644 index 00000000..3f942223 --- /dev/null +++ b/build/api-specs/alchemy/json-rpc/core-api.json @@ -0,0 +1,76 @@ +{ + "x-generated-warning": "⚠️ This file is auto-generated. Do not edit manually", + "x-fern-parameters": [ + { + "name": "apiKey", + "in": "path", + "schema": { + "type": "string", + "default": "docs-demo", + "description": "For higher throughput, [create your own API key](https://alchemy.com/?a=docs-demo)" + }, + "required": true + } + ], + "$schema": "https://meta.open-rpc.org/", + "openrpc": "1.2.4", + "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" + } + ], + "methods": [ + { + "name": "eth_blockNumber", + "tags": [ + { + "name": "Ethereum", + "description": "Ethereum Methods" + }, + { + "name": "Optimism", + "description": "Optimism Methods" + } + ], + "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": { + "title": "hex encoded unsigned integer", + "type": "string", + "pattern": "^0x([1-9a-f]+[0-9a-f]*|0)$" + } + }, + "examples": [ + { + "name": "eth_blockNumber example", + "params": [], + "result": { + "name": "Block number", + "value": "0x2377" + } + } + ] + } + ] +} \ No newline at end of file diff --git a/fern/api-reference/core-api/core-api-quickstart.mdx b/fern/api-reference/core-api/core-api-quickstart.mdx new file mode 100644 index 00000000..370bf05a --- /dev/null +++ b/fern/api-reference/core-api/core-api-quickstart.mdx @@ -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. diff --git a/fern/apis/core-api/generators.yaml b/fern/apis/core-api/generators.yaml new file mode 100644 index 00000000..3020f281 --- /dev/null +++ b/fern/apis/core-api/generators.yaml @@ -0,0 +1,3 @@ +api: + specs: + - openrpc: ../../../build/api-specs/alchemy/json-rpc/core-api.json diff --git a/fern/docs.yml b/fern/docs.yml index 80703793..07041e63 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -97,6 +97,9 @@ tabs: node: display-name: Node slug: node + nodes: + display-name: Nodes + slug: nodes navigation: - tab: get-started @@ -2438,6 +2441,52 @@ navigation: - api: Superseed API Endpoints api-name: superseed slug: superseed + - tab: nodes + layout: + - section: Quickstart + contents: + - page: Getting an API Key + path: api-reference/core-api/core-api-quickstart.mdx + - page: Installing the Alchemy SDK + path: api-reference/core-api/core-api-quickstart.mdx + - page: Making your first request + path: api-reference/core-api/core-api-quickstart.mdx + - section: Concepts + contents: + - page: Blockchains + path: api-reference/core-api/core-api-quickstart.mdx + - page: Nodes + path: api-reference/core-api/core-api-quickstart.mdx + - page: Hamsters + path: api-reference/core-api/core-api-quickstart.mdx + - section: "How-to Guides" + contents: + - page: How to deploy a smart contract + path: api-reference/core-api/core-api-quickstart.mdx + - page: How to launch an ERC-20 token + path: api-reference/core-api/core-api-quickstart.mdx + - section: API Reference + contents: + - section: Core API + contents: + - page: What is the Core API? + path: api-reference/core-api/core-api-quickstart.mdx + - api: Ethereum Methods + api-name: core-api + - api: Optimism Methods + api-name: core-api + - section: Trace API + contents: + - page: What is the Trace API? + path: api-reference/trace-api/trace-api-quickstart.mdx + - api: Trace API Methods + api-name: trace + - section: Debug API + contents: + - page: What is the Debug API? + path: api-reference/debug-api/debug-api-quickstart.mdx + - api: Debug API Methods + api-name: debug analytics: ga4: diff --git a/package.json b/package.json index 0944f6df..7787c9c6 100644 --- a/package.json +++ b/package.json @@ -58,5 +58,6 @@ "remark-preset-lint-recommended": "^7.0.1", "typescript": "^5.8.3", "typescript-eslint": "^8.31.0" - } + }, + "packageManager": "pnpm@8.15.3+sha1.64838798f519c18029c1e8a1310e16101fc2eda0" } diff --git a/src/openrpc/alchemy/core-api/base.yaml b/src/openrpc/alchemy/core-api/base.yaml new file mode 100644 index 00000000..cfd47e39 --- /dev/null +++ b/src/openrpc/alchemy/core-api/base.yaml @@ -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", + }, + ] diff --git a/src/openrpc/alchemy/core-api/methods.yaml b/src/openrpc/alchemy/core-api/methods.yaml new file mode 100644 index 00000000..3a45dadf --- /dev/null +++ b/src/openrpc/alchemy/core-api/methods.yaml @@ -0,0 +1,19 @@ +- name: eth_blockNumber + tags: + - name: "Ethereum" + description: "Ethereum Methods" + - name: "Optimism" + description: "Optimism Methods" + 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"