Overzicht
De Quicknode SDK is één SDK waarmee je vanuit de programmeertaal die je al gebruikt – Rust, Python, Node.js en Ruby – met de API’s van Quicknode-producten kunt werken.
Gebruik het om Quicknode-productworkflows, operationele diensten, scripts en AI-agenten te bouwen die getypeerde toegang nodig hebben tot:
- Beheer-API: Beheer eindpunten, gebruik, facturering, teams, eindpuntbeveiliging, tarieflimieten, logboeken, statistieken en accounttags.
- RPC: Make on-chain JSON-RPC calls to any supported network without provisioning an endpoint.
- Streams: Streams aanmaken, bijwerken, pauzeren, activeren, testen en verwijderen.
- Webhooks: Maak en beheer webhook-abonnementen op basis van Quicknode-webhook-sjablonen.
- Sleutel-waarde-opslag: Sla sets en lijsten op en haal ze op voor de applicatiestatus, streamfilters, watchlists, cursors en het geheugen van de agent.
- SQL Explorer: Voer SQL-query's uit op geïndexeerde blockchain-gegevens en haal tabelschema's op.
Uitgebreide handleiding voor ontwikkelaars en partners die met de Quicknode SDK werken:
Wanneer moet je de SDK gebruiken?
Gebruik de SDK als je één consistente client wilt voor de API’s van Quicknode-producten, met name wanneer je app of agent meerdere producten binnen één workflow moet coördineren.
Veelvoorkomende werkprocessen zijn onder meer:
- Maak eindpunten aan of beheer ze met de Admin API.
- Make on-chain JSON-RPC calls to any supported network.
- Maak een stream aan en stuur gefilterde on-chain-gegevens naar een webhook-bestemming.
- Sla de verwerkingsstatus of watchlists op in de Key-Value Store.
- Maak webhooks aan op basis van sjablonen en beheer hun levenscyclus.
- Voer met SQL Explorer SQL-query’s uit op geïndexeerde blockchain-gegevens.
- Stel workflows voor build-agents samen waarmee de status van accounts kan worden gecontroleerd, resources kunnen worden toegewezen en de testinfrastructuur kan worden opgeruimd.
Pakketten
| Taal | Verpakking | Installeren |
|---|---|---|
| Node.js / TypeScript | @quicknode/sdk | npm install @quicknode/sdk |
| Python | quicknode-sdk | pip install quicknode-sdk |
| Roest | quicknode-sdk | cargo add quicknode-sdk --features rust |
| Ruby | quicknode_sdk | gem install quicknode_sdk |
Platformondersteuning
De SDK is opgebouwd rond een gedeelde Rust-kern met bindingen voor specifieke talen. De kern wordt voor elk ondersteund platform gecompileerd tot native bibliotheken, wat je voorspelbare prestaties en een kleine afhankelijkheidsoverdruk oplevert. Het nadeel is dat we binaire bestanden publiceren voor een specifieke reeks doelsystemen, in plaats van dat de SDK in elke omgeving draait die onze hosttalen ondersteunen.
Ondersteunde doelen
Er worden vooraf gecompileerde native modules gepubliceerd voor:
| Platform | Doelstellingen |
|---|---|
| Linux (glibc) | x86_64, aarch64 op glibc 2.17+ (manylinux2014) |
| Linux (musl) | x86_64, aarch64 op Alpine en andere musl-distributies |
| macOS | Apple Silicon (arm64) |
De Linux glibc-binaire bestanden zijn gebouwd op basis van glibc 2.17, waardoor ze op elke distributie werken die vanaf 2014 is uitgebracht, waaronder RHEL 7+, Ubuntu 14.04+, Debian 8+, Amazon Linux 2+, SLES 12+ en Fedora 19+.
Niet ondersteund
- Browsers: De Quicknode SDK is niet compatibel met browsers. De SDK maakt gebruik van een Rust-kern via native bindingen, waarvoor Node.js of een andere runtime nodig is die native add-ons ondersteunt. Standaard browserbundels kunnen deze bindingen niet laden.
- Windows: Er is geen voorgecompileerd binaire bestand beschikbaar. WSL2 werkt en is de aanbevolen methode voor Windows-ontwikkelaars.
- Intel macOS: uitsluitend Apple Silicon.
- Oudere Linux-distributies: onder de glibc-drempel: RHEL/CentOS 6 (glibc 2.12), Debian 7 (glibc 2.13), Ubuntu 12.04 (glibc 2.15), SLES 11 (glibc 2.11).
Op een niet-ondersteund platform mislukt het importeren van de SDK al snel tijdens het laden, waarbij een foutmelding verschijnt met een overzicht van de beschikbare doelen. De fout treedt op tijdens de installatie of het importeren, niet bij de eerste aanroep.
Productklanten
Stel de SDK één keer samen en gebruik vervolgens de productclients die vanuit die gedeelde configuratie beschikbaar worden gesteld.
| Klant | Doel | REST-API |
|---|---|---|
admin | Eindpunten, teams, gebruik, logbestanden, facturering, statistieken, beveiliging en tarieflimieten | https://api.quicknode.com/v0/ |
rpc | On-chain JSON-RPC calls to any supported network via Tooling Access | Account Tooling Access endpoint |
stromen | Het aanmaken, bijwerken en de levenscyclus van streams, en het testen van filters | https://api.quicknode.com/streams/rest/v1/ |
webhooks | Webhook-sjablonen, bestemmingen, levenscyclus en aantallen | https://api.quicknode.com/webhooks/rest/v1/ |
kvstore | Sets en lijsten voor een permanente status | https://api.quicknode.com/kv/rest/v1/ |
sql | SQL-query’s op geïndexeerde blockchain-gegevens | https://api.quicknode.com/sql/rest/v1/ |
Het startpunt van de SDK is QuicknodeSdk in elke taalbinding. Ruby stelt het beschikbaar als QuicknodeSdk::SDK.
Methoden van SQL Explorer
De sql De client biedt twee methoden:
query(sql, clusterId): Voer een SQL-query uit op geïndexeerde blockchain-gegevens. Geeft getypeerde rijen en querystatistieken terug (credits, gescande rijen, gelezen bytes).getSchema(clusterId): Haal het tabelschema voor een cluster op.
const qn = new QuicknodeSdk();
// Run a SQL query
const resp = await qn.sql.query(
"SELECT action_type, user FROM hyperliquid_system_actions LIMIT 3",
"hyperliquid-core-mainnet"
);
console.log(`${resp.rows} rows, ${resp.credits} credits`);
// Get the schema for a cluster
const schema = await qn.sql.getSchema("hyperliquid-core-mainnet");
Authenticatie
Maak een API-sleutel aan in de Quicknode-dashboard, en configureer vervolgens de SDK met de QN_SDK__API_KEY omgevingsvariabele.
exporteren QN_SDK__API_KEY="UW_API_SLEUTEL"
De SDK ondersteunt ook het overschrijven van de basis-URL voor lokale ontwikkeling, staging en agent-sandboxes:
| Omgevingsvariabele | Standaard |
|---|---|
QN_SDK__ADMIN__BASE_URL | https://api.quicknode.com/v0/ |
QN_SDK__STREAMS__BASE_URL | https://api.quicknode.com/streams/rest/v1/ |
QN_SDK__WEBHOOKS__BASE_URL | https://api.quicknode.com/webhooks/rest/v1/ |
QN_SDK__KVSTORE__BASE_URL | https://api.quicknode.com/kv/rest/v1/ |
QN_SDK__SQL__BASE_URL | https://api.quicknode.com/sql/rest/v1/ |
QN_SDK__HTTP__TIMEOUT_SECS | 30 |
Voor makelaars
De SDK is ontworpen om zowel voor mensen als voor agents bruikbaar te zijn. Agents kunnen één SDK-handle initialiseren, dezelfde inloggegevens voor verschillende productclients hergebruiken en gebruikmaken van getypeerde methode-invoer en -responsen, in plaats van voor elke workflow afzonderlijke, onbewerkte REST-aanroepen samen te stellen.
Volgende stappen
- Begin met de QuickStart om de SDK te installeren en in te stellen.
- Use Examples to see Admin API, RPC & Tooling Access, Streams, Webhooks, and Key-Value Store workflows.
- Raadpleeg de API-documentatie van het product voor een volledig overzicht van het gedrag van de eindpunten: Admin API, Streams, Webhooks, Key-Value Store en SQL Explorer.
We ❤️ feedback
Geef ons feedback over ontbrekende methoden, naamgeving, voorbeelden en agentworkflows, zodat we de SDK kunnen blijven verbeteren.