quicknode_sdk 0.3.0-aarch64-linux → 0.5.0-aarch64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7fcb168d49b23d4246f2d6fa1a7b789b8f3d00958a3caa85d6d99f67c785410
-  data.tar.gz: 29894e65c3c81dc7245de9a01172b18fca57e270fa0fa639c457e334a4db37ab
+  metadata.gz: 1799801200a8bd2398578efea491e9752a76b471e7b3a2b7c746f38c295074c2
+  data.tar.gz: 404c3c0cd3246bb57155c62f86e8703561b3d82d17e7d6e81af996dedca43b0c
 SHA512:
-  metadata.gz: 9faf274103765ee8cad1cadfd96410163c6a30c45d78fec15959b93d3b4d4760ad16d6032ea778eb8f2bf4cce5d9c8f96ca2aa494bd8141fe82dfa7903133f59
-  data.tar.gz: 12d1d1afb8276dcd951e2317e5f3e86ab555f60046fc261edca0b6a0c6a2cd243df7312c0bf5a99eec39f93b62a5e4c034c270b7f26c177e223d49a16a451712
+  metadata.gz: e823f53aa2599d86115b6be9df96ab1a58fdd98d250d0c26ab0f13e81195a24490e3c9a20def590144ce32d8e1b1591bd7a14e7b06b0456215447f9105dcb83e
+  data.tar.gz: 85de7cc321550af364578240366188a5491e7ae8f990f707e0c21d46d771c61cce13ad176d1a62856519ccbc2a0ae0d64c3197aa88c2f7fcae6207e8c8e38cd6

data/README.md

@@ -46,6 +46,7 @@ This is one of four language bindings published from the same Rust core. See the
   - [KV Store Client](#kv-store-client)
     - [Sets](#sets)
     - [Lists](#lists)
+  - [SQL Client](#sql-client)
 - [Error Handling](#error-handling)
 - [License](#license)
 
@@ -55,7 +56,7 @@ This is one of four language bindings published from the same Rust core. See the
 
 ## Quick Start
 
-Construct the SDK once, then reach into the four sub-clients (`admin`, `streams`, `webhooks`, `kvstore`). Subsequent API Reference snippets assume you have a `qn` handle from one of these blocks.
+Construct the SDK once, then reach into the five sub-clients (`admin`, `streams`, `webhooks`, `kvstore`, `sql`). Subsequent API Reference snippets assume you have a `qn` handle from one of these blocks.
 
 ```ruby
 # Ruby
@@ -94,6 +95,7 @@ Environment variables (prefix `QN_SDK__`, separator `__`):
 | `QN_SDK__STREAMS__BASE_URL` | no | `https://api.quicknode.com/streams/rest/v1/` | Override streams base URL |
 | `QN_SDK__WEBHOOKS__BASE_URL` | no | `https://api.quicknode.com/webhooks/rest/v1/` | Override webhooks base URL |
 | `QN_SDK__KVSTORE__BASE_URL` | no | `https://api.quicknode.com/kv/rest/v1/` | Override KV store base URL |
+| `QN_SDK__SQL__BASE_URL` | no | `https://api.quicknode.com/sql/rest/v1/` | Override SQL Explorer base URL |
 | `QN_SDK__HTTP__HEADERS__<NAME>` | no | — | Custom HTTP header sent on every request. Overrides SDK-managed headers (see below). |
 
 ### Custom headers and `User-Agent`
@@ -547,7 +549,7 @@ qn.admin.delete_token(id: "ep-123", token_id: "tok-1")
 
 Whitelists a referrer URL or domain on an endpoint.
 
-**Parameters**: `id` (endpoint id, required); body: `referrer` (string, optional).
+**Parameters**: `id` (endpoint id, required); body: `referrer` (string, required).
 
 **Returns**: nothing.
 
@@ -575,7 +577,7 @@ qn.admin.delete_referrer(id: "ep-123", referrer_id: "ref-1")
 
 Whitelists an IP address on an endpoint.
 
-**Parameters**: `id` (endpoint id, required); body: `ip` (string, optional).
+**Parameters**: `id` (endpoint id, required); body: `ip` (string, required).
 
 **Returns**: nothing.
 
@@ -631,7 +633,7 @@ qn.admin.delete_domain_mask(id: "ep-123", domain_mask_id: "dm-1")
 
 Configures JWT validation on an endpoint.
 
-**Parameters**: `id` (endpoint id, required); body: `public_key` (string, optional), `kid` (string, required), `name` (string, optional).
+**Parameters**: `id` (endpoint id, required); body: `public_key` (string, required), `kid` (string, required), `name` (string, required).
 
 **Returns**: nothing.
 
@@ -664,7 +666,7 @@ Whitelist specific RPC methods on an endpoint. Requests for methods not on the l
 
 ##### `create_request_filter` / `createRequestFilter`
 
-**Parameters**: `id` (endpoint id, required); body: `method` (string[], optional). Ruby's Hash key is `methods` (plural).
+**Parameters**: `id` (endpoint id, required); body: `method` (string[], required). Ruby's Hash key is `methods` (plural).
 
 **Returns**: `CreateRequestFilterResponse` with `data.id`.
 
@@ -1613,6 +1615,44 @@ Deletes a list and all of its items.
 qn.kvstore.delete_list(key: "my-list")
 ```
 
+---
+
+### SQL Client
+
+Accessed as `qn.sql`. Runs SQL queries against indexed blockchain data and fetches the database schema. Backed by `https://api.quicknode.com/sql/rest/v1/`.
+
+##### `query`
+
+Executes a SQL query against a cluster and returns the result set. Paginate by writing `LIMIT`/`OFFSET` into the SQL.
+
+**Parameters** (Hash): `query:` (String, required), `cluster_id:` (String, required).
+
+**Returns** a Hash with `meta` (column metadata, each with `name` and `type`), `data` (rows as Hashes keyed by column name), `rows`, `rows_before_limit_at_least`, `statistics` (`elapsed`, `rows_read`, `bytes_read`), and `credits`. Access with `[]` or `dig`.
+
+```ruby
+# Ruby
+resp = qn.sql.query(
+  query: "SELECT action_type, user FROM hyperliquid_system_actions ORDER BY block_time DESC LIMIT 100",
+  cluster_id: "hyperliquid-core-mainnet"
+)
+puts resp[:rows]
+puts resp[:data].first
+```
+
+##### `get_schema`
+
+Fetches the database schema for a cluster: table names, columns, types, sort keys, and partition strategies.
+
+**Parameters** (Hash): `cluster_id:` (String, required).
+
+**Returns** a Hash with `chain`, `cluster_id`, and `tables` (each with `name`, `engine`, `total_rows`, `partition_key`, `sorting_key`, and `columns` of `{ name, type }`).
+
+```ruby
+# Ruby
+schema = qn.sql.get_schema(cluster_id: "hyperliquid-core-mainnet")
+puts schema[:tables].length
+```
+
 ## Error Handling
 
 Every binding exposes a typed exception hierarchy derived from the core `SdkError`

data/lib/quicknode_sdk/clients/sql.rb

@@ -0,0 +1,4 @@
+module QuicknodeSdk
+  class Sql < NativeDelegator
+  end
+end

data/lib/quicknode_sdk/sdk.rb

@@ -34,5 +34,9 @@ module QuicknodeSdk
     def kvstore
       KvStore.new(@native.kvstore)
     end
+
+    def sql
+      Sql.new(@native.sql)
+    end
   end
 end

data/lib/quicknode_sdk.rb

@@ -13,4 +13,5 @@ require_relative "quicknode_sdk/clients/admin"
 require_relative "quicknode_sdk/clients/streams"
 require_relative "quicknode_sdk/clients/webhooks"
 require_relative "quicknode_sdk/clients/kvstore"
+require_relative "quicknode_sdk/clients/sql"
 require_relative "quicknode_sdk/sdk"

data/sig/quicknode_sdk.rbs

@@ -33,6 +33,7 @@ module QuicknodeSdk
     def streams: () -> Streams
     def webhooks: () -> Webhooks
     def kvstore: () -> KvStore
+    def sql: () -> Sql
   end
 
   class DestinationAttributes
@@ -64,15 +65,15 @@ module QuicknodeSdk
     def update_security_options: (id: String, ?tokens: String, ?referrers: String, ?jwts: String, ?ips: String, ?domain_masks: String, ?hsts: String, ?cors: String, ?request_filters: String, ?ip_custom_header: String) -> untyped
     def create_token: (id: String) -> void
     def delete_token: (id: String, token_id: String) -> untyped
-    def create_referrer: (id: String, ?referrer: String) -> void
+    def create_referrer: (id: String, referrer: String) -> void
     def delete_referrer: (id: String, referrer_id: String) -> untyped
-    def create_ip: (id: String, ?ip: String) -> void
+    def create_ip: (id: String, ip: String) -> void
     def delete_ip: (id: String, ip_id: String) -> untyped
     def create_domain_mask: (id: String, ?domain_mask: String) -> void
     def delete_domain_mask: (id: String, domain_mask_id: String) -> untyped
-    def create_jwt: (id: String, kid: String, ?public_key: String, ?name: String) -> void
+    def create_jwt: (id: String, kid: String, public_key: String, name: String) -> void
     def delete_jwt: (id: String, jwt_id: String) -> void
-    def create_request_filter: (id: String, ?methods: Array[String]) -> untyped
+    def create_request_filter: (id: String, methods: Array[String]) -> untyped
     def update_request_filter: (id: String, request_filter_id: String, ?methods: Array[String]) -> void
     def delete_request_filter: (id: String, request_filter_id: String) -> void
     def enable_multichain: (id: String) -> void
@@ -158,4 +159,11 @@ module QuicknodeSdk
     def delete_list_item: (key: String, item: String) -> void
     def delete_list: (key: String) -> void
   end
+
+  class Sql
+    def initialize: (untyped native) -> void
+
+    def query: (query: String, cluster_id: String) -> untyped
+    def get_schema: (cluster_id: String) -> untyped
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quicknode_sdk
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: aarch64-linux
 authors:
 - Quicknode
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-23 00:00:00.000000000 Z
+date: 2026-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -34,6 +34,7 @@ files:
 - lib/quicknode_sdk.rb
 - lib/quicknode_sdk/clients/admin.rb
 - lib/quicknode_sdk/clients/kvstore.rb
+- lib/quicknode_sdk/clients/sql.rb
 - lib/quicknode_sdk/clients/streams.rb
 - lib/quicknode_sdk/clients/webhooks.rb
 - lib/quicknode_sdk/native_delegator.rb