API-Referenz
TypeScript (@qorechain/sdk)
Die TypeScript-Pakete liefern vollständige TSDoc-Kommentare auf ihrer öffentlichen
Oberfläche mit, und eine TypeDoc-Konfiguration ist im
Core-Paket eingerichtet. So generieren Sie die HTML-API-Referenz für
@qorechain/sdk:
# from the monorepo root
pnpm --filter @qorechain/sdk docs:api
Dies führt das in packages/ts definierte Skript docs:api (typedoc) aus und
erzeugt die API-Site im docs/-Ausgabeverzeichnis dieses Pakets. Die generierte
Ausgabe wird nicht eingecheckt — führen Sie den Befehl lokal aus oder binden Sie
ihn in Ihre eigene Dokumentations-Pipeline ein.
Die eigene TypeDoc-Konfiguration der Dokumentationsseite liegt unter
docs/typedoc.json; sie verweist auf den Einstiegspunkt des Core-Pakets, sodass
Sie die Referenz auch aus dem Docs-Projekt heraus neu generieren können.
Die öffentliche Oberfläche im Überblick
Die bewusst gewählten, unterstützten Exporte von @qorechain/sdk:
- Client:
createClient, TypenQoreChainClient,CreateClientOptions,ConnectTxOptions,ClientFees. - Netzwerke: Presets, Lookup-/Listen-Helfer und Konfigurationstypen (Networks-Modul).
- Hilfsfunktionen:
toBase/fromBase(Denom), Adress-Kodierung und -Validierung. - Konten:
generateMnemonic,validateMnemonic,deriveNativeAccount,deriveEvmAccount,deriveSvmAccount; Kontotypen. - Unified Accounts (0.6.0):
deriveUnifiedAccount,unifiedAccountFromSeed(0.13.0: braucht einenQRC1-Wiederherstellungscode oder ein unabhängiges 32-Byte-PQC-Geheimnis),addressesFrom20,qoreAddressesund dieQRC1-Helfer für WiederherstellungscodesgeneratePqcRecoveryCode,isValidRecoveryCode,normalizeRecoveryCode,pqcKeyFromRecoveryCode,pqcRecoveryCodeFromSecret. (unifiedAccountFromPhantomSignatureundconnectPhantomUnifiedwurden in 0.8.0 entfernt und werfen einen Fehler.) - PQC:
generatePqcKeypair,pqcSign,pqcVerify, Längenkonstanten, Algorithmus-IDs/-Helfer,PqcSigner,HybridSigner,buildHybridSignatureExtension,HYBRID_SIG_TYPE_URL. - PQC-Schlüssel-Lebenszyklus (0.9.0):
ensurePqcRegistered(liest den Status über REST,PqcKeyMismatchError),fetchPqcStatus,isRegisteredPqcKey,buildRegisterPqcKeyMsg,signProofOfPossession/verifyProofOfPossession(PROOF_OF_POSSESSION_DOMAIN),validateRegisteredPqcKey,isDegeneratePqcPublicKey,migrateToHybrid,migratePqcKeyHybrid,isUpgradeApplied/requireUpgradeApplied(CHAIN_UPGRADE_V3_2_2,CHAIN_UPGRADE_V3_2_3,CHAIN_UPGRADE_V3_2_4). - Read-Clients:
RestClient(inkl.getPermissionSchema),JsonRpcClient,QorClient, HTTP-Helfer (getJson,postJsonRpc,buildUrl,joinUrl,QoreHttpError); typisierte Query-Clients für jedes Modul, einschließlichamm,license,abstractaccount(permissionSchema) sowie dermultilayer-State-Anchor-AbfragenAnchor/Anchors. Auf den öffentlichen Endpunkten rufen einige typisierte REST-Helfer Routen auf, die das Gateway nicht bereitstellt:getAiStats,getFeeEstimate,getXqorePosition,getInflationRateundgetReputation.getBurnStats,getAllBalances,getBridgeChains,getPermissionSchemaund (seit 0.9.0, das seinen Pfad mit Pluralaccountsauf die bereitgestellte Singular-Route/qorechain/pqc/v1/account/{address}korrigiert hat)getPqcAccountfunktionieren. - Cross-VM:
getCrossVmMessage,getPendingCrossVmMessages,getCrossVmParams. - QoreChain Native:
createCosmWasmClient,connectCosmWasmSigner,queryContractSmart,getContractInfo,instantiate,execute,uploadCode. - Transaktionen:
estimateFee,directSignerFromPrivateKey,TxClient(hybrid, wenn mitpqcKeypairverbunden, 0.9.0;HYBRID_VERIFY_GAS),MSG_SEND_TYPE_URL, Hybrid-Helfer (encodeHybridExtension,attachHybridExtension,buildHybridTx,signAndBroadcastHybrid); strukturierte Fehlerdekodierung überdecodeTxError(inkl. derabstractaccount-Codes 5/6/10/11 und despqc-Codes 21; seit 0.10.0 benennt sie auch eine Ablehnung, die während der Gebührensimulation als Text eintrifft). - eth-natives Signieren (0.6.0):
signClassicalEth,signHybridEth(secp256k1 überkeccak256(SignDoc), Pubkey-Typ/cosmos.evm.crypto.v1.ethsecp256k1.PubKey, plus die ML-DSA-87-Hybrid-Extension),EthNativeSigner,accountAuthInfo. - Authenticator-Lanes (0.7.0): Message-Composer
msg.abstractaccount.registerAuthenticator/revokeAuthenticator/executeEvm/executeCosmosund diemsg.pqc-Rotation (auch eigenständig exportiert alsexecuteEvmMsg,executeCosmosMsg,registerEthAuthenticatorMsg,revokeAuthenticatorMsg,rotatePqcKeyMsg); byte-exakte Sign-BytesevmAuthSignBytes,cosmosAuthSignBytes,rotationSignBytes; Wallet-BuilderbuildPhantomExecuteEvm/buildPhantomExecuteCosmos(ed25519signMessage) undbuildMetaMaskExecuteEvm/buildMetaMaskExecuteCosmos(EIP-191personal_sign); SchlüsselrotationrotatePqcKeyMsgFromMnemonic,derivePqcLegacy. Siehe den Authenticators-Leitfaden (das Modul hinter diesen Lanes ist im Mainnet abgeschaltet und im Testnet aktiviert). - Hybride Sign-Bytes (0.8.0+): die Option
signBytesVersion("auto" | "v1" | "v2") beibuildHybridTx,signAndBroadcastHybrid,signHybridEthundEthNativeSigner;resolveSignBytesVersion,SIGN_BYTES_V2_UPGRADES,isHybridSignBytesRejection,hybridSignBytesV1/hybridSignBytesV2,migrationSignBytes,bridgeAttestationSignBytes. - EVM-Autorisierungsfenster (0.8.2+):
openEvmWindowMsg(nativeOnlyundallowedTargetsab 0.9.0),closeEvmWindowMsg,fetchEvmWindow,classifyEvmWindowRejection,isEvmWindowRejection,MAX_EVM_WINDOW_BLOCKS,MAX_EVM_WINDOW_TXS,MAX_EVM_WINDOW_TARGETS. Siehe EVM-Autorisierungsfenster. - EIP-7702-Zustimmung (0.9.0):
authorizeEvmDelegationMsg,clearEvmDelegationMsg,fetchEvmDelegationConsent,evmDelegationTupleNonce,classifyEvmDelegationRejection,EVM_DELEGATION_CLEAR,MAX_EVM_DELEGATION_CONSENT_BLOCKS. - Abstract-Account-Digest v2 (0.9.0):
evmAuthSignBytesV2,resolveEvmAuthDigestVersion;validateSpendingRules. - Chain v3.2.4 (0.10.0): Staking-Tiers (
msg.stakingtier.lockDelegation/unlockEarly/claimBonus/updateParams,validateLockDelegation,STAKING_LOCK_MONTHS,fetchStakingTierParams,fetchStakingLocks,fetchStakingTierPool);fetchAuthNonce;fetchProtocolFeatures/isProtocolFeatureEnabled;possessionProvenim PQC-Status;ibcTimeoutTimestamp;CHAIN_UPGRADE_V3_2_4. Siehe Was 0.10.0 hinzugefügt hat. - Chain v3.2.5 (0.12.0): das ML-KEM-1024-Schlüsselregister (
msg.pqc.registerKemKey/removeKemKey,validateKemPublicKey,fetchKemKey,parseKemKey,KEM_ALGORITHM_ML_KEM_1024,ML_KEM_1024_PUBLIC_KEY_SIZE); exaktes Gas für Hybrid- Transaktionen (exactHybridGas,EXACT_GAS_MULTIPLIER,EXACT_GAS_HEADROOM,TxClient.estimateGasDetails); Abstract-Account-Lesezugriffe (fetchSpendingRules,fetchAuthenticators) undmsg.abstractaccount.updateConfig; geprüfte Builder für Governance-Parameter (validateCrossVmUpdateParams,validateRdkUpdateParams);CHAIN_UPGRADE_V3_2_5; das Presetlocalnet. Siehe Was 0.12.0 hinzufügt. - Kanonische PQC-Ableitung (0.8.3+):
derivePqcCanonical(account, mnemonic),canonicalAccount(account); die PQC-Registrierungsnachricht istbuildRegisterPqcKeyMsg(verwendet vonensurePqcRegistered).derivePqcLegacyist für neue Schlüssel veraltet.
@qorechain/evm
createEvmClient, evmAccountFromPrivateKey, die erc20-Helfer,
Contract-Wrapper (deployContract, readContract, writeContract), die
precompiles-Bindings, die Precompile-gestützten Helfer simulateWithRiskScore,
aiRiskScore und aiAnomalyCheck, PRECOMPILE_ADDRESSES und die ABIs
(ERC20_ABI, IQORE_PQC_ABI, IQORE_AI_ABI, IQORE_CONSENSUS_ABI). Die
Precompile-gestützten Bindings und Helfer sind auf den öffentlichen Netzwerken
nicht aktiv (siehe
EVM-Precompiles).
@qorechain/svm
createSvmClient, DEFAULT_SVM_RPC_URL, svmKeypairFromSecretKey,
svmAddress, die Program-Builder (createMemoInstruction,
createTransferTokenInstruction, createAssociatedTokenAccountInstruction,
getAssociatedTokenAddress, createInvokeInstruction) sowie die
Program-ID-Konstanten.
Weitere Sprachen
| Sprache | Generierte Dokumentation | Installation |
|---|---|---|
| Python | PyPI — Docstrings auf der öffentlichen API | pip install qorechain-sdk in Version 0.14.0 (Import qorsdk) |
| Go | pkg.go.dev (godoc) | go get github.com/qorechain/qorechain-sdk/packages/go/...@v0.14.0 (Tag packages/go/v0.14.0) |
| Rust | docs.rs (rustdoc) | cargo add qorechain-sdk (0.14.0; Import qorechain) |
| Java | Maven-Central-Javadoc | io.github.qorechain:qorechain-sdk:0.14.0 |
Jedes Paket spiegelt dieselbe Oberfläche wider (Netzwerk-Presets,
Denom-/Adress-Hilfsfunktionen, HD-Ableitung — einschließlich unified
eth-nativer Konten — PQC-Primitive und Hybrid-Signieren, typisierte Messages
und Queries, die Authenticator-Lanes sowie REST- und
qor_-JSON-RPC-Read-Clients), dokumentiert direkt im Quellcode, sodass das
sprachspezifische Dokumentations-Tooling sie rendert. Die
TypeScript-Wallet-Builder (buildPhantom* / buildMetaMask*) und die
Browser-Wallet-Adapter gibt es nur in TypeScript.