API referansı
TypeScript (@qorechain/sdk)
TypeScript paketleri, herkese açık yüzeylerinde eksiksiz TSDoc ile birlikte gelir
ve çekirdek pakete bir TypeDoc yapılandırması bağlanmıştır.
@qorechain/sdk için HTML API referansını oluşturmak üzere:
# from the monorepo root
pnpm --filter @qorechain/sdk docs:api
Bu komut, packages/ts içinde tanımlı docs:api betiğini (typedoc) çalıştırır
ve API sitesini o paketin docs/ çıktı dizini altında üretir. Oluşturulan çıktı
depoya eklenmez — komutu yerelde çalıştırın veya kendi dokümantasyon hattınıza
bağlayın.
Dokümantasyon sitesinin kendi TypeDoc yapılandırması docs/typedoc.json
konumundadır; çekirdek paketin giriş noktasına işaret eder, böylece docs
projesinden de yeniden üretebilirsiniz.
Bir bakışta herkese açık yüzey
@qorechain/sdk paketinin bilinçli olarak desteklenen dışa aktarımları:
- İstemci:
createClient, tiplerQoreChainClient,CreateClientOptions,ConnectTxOptions,ClientFees. - Ağlar: hazır ayarlar, arama/listeleme yardımcıları ve yapılandırma tipleri (networks modülü).
- Yardımcılar:
toBase/fromBase(denom), adres kodlama/doğrulama. - Hesaplar:
generateMnemonic,validateMnemonic,deriveNativeAccount,deriveEvmAccount,deriveSvmAccount; hesap tipleri. - Birleşik hesaplar (0.6.0):
deriveUnifiedAccount,unifiedAccountFromSeed(0.13.0: birQRC1kurtarma kodu veya bağımsız 32 baytlık bir PQC sırrı gerektirir),addressesFrom20,qoreAddressesveQRC1kurtarma kodu yardımcılarıgeneratePqcRecoveryCode,isValidRecoveryCode,normalizeRecoveryCode,pqcKeyFromRecoveryCode,pqcRecoveryCodeFromSecret. (unifiedAccountFromPhantomSignatureveconnectPhantomUnified0.8.0'da kaldırıldı ve hata fırlatır.) - PQC:
generatePqcKeypair,pqcSign,pqcVerify, uzunluk sabitleri, algoritma kimlikleri/yardımcıları,PqcSigner,HybridSigner,buildHybridSignatureExtension,HYBRID_SIG_TYPE_URL. - PQC anahtar yaşam döngüsü (0.9.0):
ensurePqcRegistered(durumu REST üzerinden okur,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). - Okuma istemcileri:
RestClient(getPermissionSchemadahil),JsonRpcClient,QorClient, HTTP yardımcıları (getJson,postJsonRpc,buildUrl,joinUrl,QoreHttpError);amm,license,abstractaccount(permissionSchema) vemultilayerAnchor/Anchorsdurum-çapa sorguları dahil olmak üzere her modül için tipli sorgu istemcileri. Genel uç noktalarda bazı tipli REST yardımcıları, ağ geçidinin sunmadığı rotaları çağırır:getAiStats,getFeeEstimate,getXqorePosition,getInflationRatevegetReputation.getBurnStats,getAllBalances,getBridgeChains,getPermissionSchemave (çoğulaccountsyolunu sunulan tekil/qorechain/pqc/v1/account/{address}rotasına düzelten 0.9.0'dan beri)getPqcAccountçalışır. - Cross-VM:
getCrossVmMessage,getPendingCrossVmMessages,getCrossVmParams. - QoreChain Native:
createCosmWasmClient,connectCosmWasmSigner,queryContractSmart,getContractInfo,instantiate,execute,uploadCode. - İşlemler:
estimateFee,directSignerFromPrivateKey,TxClient(pqcKeypairile bağlanıldığında hibrit, 0.9.0;HYBRID_VERIFY_GAS),MSG_SEND_TYPE_URL, hibrit yardımcılar (encodeHybridExtension,attachHybridExtension,buildHybridTx,signAndBroadcastHybrid);decodeTxErrorile yapılandırılmış hata çözümleme (abstractaccountkodları 5/6/10/11 vepqckodu 21 dahil; 0.10.0'dan beri ücret simülasyonu sırasında metin olarak gelen bir reddi de adlandırır). - eth-native imzalama (0.6.0):
signClassicalEth,signHybridEth(keccak256(SignDoc)üzerinde secp256k1, pubkey tipi/cosmos.evm.crypto.v1.ethsecp256k1.PubKey, ayrıca ML-DSA-87 hibrit uzantısı),EthNativeSigner,accountAuthInfo. - Authenticator hatları (0.7.0): mesaj oluşturucular
msg.abstractaccount.registerAuthenticator/revokeAuthenticator/executeEvm/executeCosmosvemsg.pqcrotasyonu (ayrıca bağımsız olarakexecuteEvmMsg,executeCosmosMsg,registerEthAuthenticatorMsg,revokeAuthenticatorMsg,rotatePqcKeyMsgadlarıyla dışa aktarılır); bayt düzeyinde birebir imza baytlarıevmAuthSignBytes,cosmosAuthSignBytes,rotationSignBytes; cüzdan oluşturucularbuildPhantomExecuteEvm/buildPhantomExecuteCosmos(ed25519signMessage) vebuildMetaMaskExecuteEvm/buildMetaMaskExecuteCosmos(EIP-191personal_sign); anahtar rotasyonurotatePqcKeyMsgFromMnemonic,derivePqcLegacy. Bkz. Authenticator kılavuzu (bu hatların arkasındaki modül mainnet'te kapalı, testnet'te etkindir). - Hibrit imza baytları (0.8.0+):
buildHybridTx,signAndBroadcastHybrid,signHybridEthveEthNativeSignerüzerindekisignBytesVersionseçeneği ("auto" | "v1" | "v2");resolveSignBytesVersion,SIGN_BYTES_V2_UPGRADES,isHybridSignBytesRejection,hybridSignBytesV1/hybridSignBytesV2,migrationSignBytes,bridgeAttestationSignBytes. - EVM yetkilendirme penceresi (0.8.2+):
openEvmWindowMsg(nativeOnlyveallowedTargets0.9.0'dan itibaren),closeEvmWindowMsg,fetchEvmWindow,classifyEvmWindowRejection,isEvmWindowRejection,MAX_EVM_WINDOW_BLOCKS,MAX_EVM_WINDOW_TXS,MAX_EVM_WINDOW_TARGETS. Bkz. EVM yetkilendirme penceresi. - EIP-7702 onayı (0.9.0):
authorizeEvmDelegationMsg,clearEvmDelegationMsg,fetchEvmDelegationConsent,evmDelegationTupleNonce,classifyEvmDelegationRejection,EVM_DELEGATION_CLEAR,MAX_EVM_DELEGATION_CONSENT_BLOCKS. - Abstract-account özeti v2 (0.9.0):
evmAuthSignBytesV2,resolveEvmAuthDigestVersion;validateSpendingRules. - Zincir v3.2.4 (0.10.0): staking katmanları (
msg.stakingtier.lockDelegation/unlockEarly/claimBonus/updateParams,validateLockDelegation,STAKING_LOCK_MONTHS,fetchStakingTierParams,fetchStakingLocks,fetchStakingTierPool);fetchAuthNonce;fetchProtocolFeatures/isProtocolFeatureEnabled; PQC durumundapossessionProven;ibcTimeoutTimestamp;CHAIN_UPGRADE_V3_2_4. Bkz. 0.10.0'ın eklediği. - Zincir v3.2.5 (0.12.0): ML-KEM-1024 anahtar kayıt defteri (
msg.pqc.registerKemKey/removeKemKey,validateKemPublicKey,fetchKemKey,parseKemKey,KEM_ALGORITHM_ML_KEM_1024,ML_KEM_1024_PUBLIC_KEY_SIZE); hibrit işlemler için kesin gas (exactHybridGas,EXACT_GAS_MULTIPLIER,EXACT_GAS_HEADROOM,TxClient.estimateGasDetails); abstract-account okumaları (fetchSpendingRules,fetchAuthenticators) vemsg.abstractaccount.updateConfig; denetlenmiş yönetişim parametresi oluşturucuları (validateCrossVmUpdateParams,validateRdkUpdateParams);CHAIN_UPGRADE_V3_2_5;localnethazır ayarı. Bkz. 0.12.0 neler ekliyor. - Kanonik PQC türetme (0.8.3+):
derivePqcCanonical(account, mnemonic),canonicalAccount(account); PQC kayıt mesajıbuildRegisterPqcKeyMsg'dir (ensurePqcRegisteredtarafından kullanılır).derivePqcLegacyyeni anahtarlar için kullanımdan kaldırılmıştır.
@qorechain/evm
createEvmClient, evmAccountFromPrivateKey, erc20 yardımcıları, sözleşme
sarmalayıcıları (deployContract, readContract, writeContract), precompiles
bağlamaları, precompile destekli yardımcılar simulateWithRiskScore,
aiRiskScore ve aiAnomalyCheck, PRECOMPILE_ADDRESSES ve ABI'ler
(ERC20_ABI, IQORE_PQC_ABI, IQORE_AI_ABI, IQORE_CONSENSUS_ABI).
Precompile destekli bağlamalar ve yardımcılar genel ağlarda etkin değildir
(bkz. EVM Precompile'ları).
@qorechain/svm
createSvmClient, DEFAULT_SVM_RPC_URL, svmKeypairFromSecretKey,
svmAddress, program oluşturucular (createMemoInstruction,
createTransferTokenInstruction, createAssociatedTokenAccountInstruction,
getAssociatedTokenAddress, createInvokeInstruction) ve program kimliği
sabitleri.
Diğer diller
| Dil | Oluşturulan dokümanlar | Kurulum |
|---|---|---|
| Python | PyPI — herkese açık API üzerinde docstring'ler | 0.14.0 sürümünde pip install qorechain-sdk (qorsdk olarak içe aktarılır) |
| Go | pkg.go.dev (godoc) | go get github.com/qorechain/qorechain-sdk/packages/go/...@v0.14.0 (etiket packages/go/v0.14.0) |
| Rust | docs.rs (rustdoc) | cargo add qorechain-sdk (0.14.0; qorechain olarak içe aktarılır) |
| Java | Maven Central javadoc | io.github.qorechain:qorechain-sdk:0.14.0 |
Her paket aynı yüzeyi yansıtır (ağ hazır ayarları, denom/adres yardımcıları,
HD türetme — birleşik eth-native hesaplar dahil — PQC temel bileşenleri ve
hibrit imzalama, tipli mesajlar ve sorgular, authenticator hatları ve
REST + qor_ JSON-RPC okuma istemcileri) ve dile özgü dokümantasyon
araçlarının işleyebilmesi için kaynak kodda satır içi belgelenmiştir.
TypeScript cüzdan oluşturucuları (buildPhantom* / buildMetaMask*) ve
tarayıcı cüzdanı bağdaştırıcıları yalnızca TypeScript'te mevcuttur.