Referință API
TypeScript (@qorechain/sdk)
Pachetele TypeScript sunt livrate cu TSDoc complet pe suprafața lor publică, iar
o configurație TypeDoc este integrată în pachetul core.
Pentru a genera referința API în format HTML pentru @qorechain/sdk:
# from the monorepo root
pnpm --filter @qorechain/sdk docs:api
Aceasta rulează scriptul docs:api (typedoc) definit în packages/ts,
producând site-ul API în directorul de ieșire docs/ al acelui pachet.
Rezultatul generat nu este comis în repo — rulați comanda local sau
integrați-o în propriul vostru pipeline de documentație.
Configurația TypeDoc proprie a site-ului de documentație se află la
docs/typedoc.json; aceasta indică spre punctul de intrare al pachetului core,
astfel încât puteți regenera și din proiectul de documentație.
Suprafața publică pe scurt
Exporturile deliberate, suportate, ale @qorechain/sdk:
- Client:
createClient, tipurileQoreChainClient,CreateClientOptions,ConnectTxOptions,ClientFees. - Rețele: preseturi, funcții ajutătoare de căutare/listare și tipuri de configurare (modulul networks).
- Utilitare:
toBase/fromBase(denom), codificare/validare de adrese. - Conturi:
generateMnemonic,validateMnemonic,deriveNativeAccount,deriveEvmAccount,deriveSvmAccount; tipuri de conturi. - Conturi unificate (0.6.0):
deriveUnifiedAccount,unifiedAccountFromSeed(0.13.0: cere un cod de recuperareQRC1sau un secret PQC independent de 32 de bytes),addressesFrom20,qoreAddressesși helperele de cod de recuperareQRC1generatePqcRecoveryCode,isValidRecoveryCode,normalizeRecoveryCode,pqcKeyFromRecoveryCode,pqcRecoveryCodeFromSecret. (unifiedAccountFromPhantomSignatureșiconnectPhantomUnifiedau fost eliminate în 0.8.0 și aruncă o eroare.) - PQC:
generatePqcKeypair,pqcSign,pqcVerify, constante de lungime, ID-uri de algoritmi/funcții ajutătoare,PqcSigner,HybridSigner,buildHybridSignatureExtension,HYBRID_SIG_TYPE_URL. - Ciclul de viață al cheii PQC (0.9.0):
ensurePqcRegistered(citește starea prin 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). - Clienți de citire:
RestClient(incl.getPermissionSchema),JsonRpcClient,QorClient, funcții ajutătoare HTTP (getJson,postJsonRpc,buildUrl,joinUrl,QoreHttpError); clienți de interogare tipizați pentru fiecare modul, inclusivamm,license,abstractaccount(permissionSchema) și interogările de ancore de stareAnchor/Anchorsdin modululmultilayer. Pe endpoint-urile publice, unele funcții REST tipizate apelează rute pe care gateway-ul nu le servește:getAiStats,getFeeEstimate,getXqorePosition,getInflationRateșigetReputation.getBurnStats,getAllBalances,getBridgeChains,getPermissionSchemași (începând cu 0.9.0, care a corectat calea saaccountsla plural în ruta servită, la singular,/qorechain/pqc/v1/account/{address})getPqcAccountfuncționează. - Cross-VM:
getCrossVmMessage,getPendingCrossVmMessages,getCrossVmParams. - QoreChain Native:
createCosmWasmClient,connectCosmWasmSigner,queryContractSmart,getContractInfo,instantiate,execute,uploadCode. - Tranzacții:
estimateFee,directSignerFromPrivateKey,TxClient(hibrid când este conectat cupqcKeypair, 0.9.0;HYBRID_VERIFY_GAS),MSG_SEND_TYPE_URL, funcții ajutătoare hibride (encodeHybridExtension,attachHybridExtension,buildHybridTx,signAndBroadcastHybrid); decodare structurată a erorilor prindecodeTxError(incl. codurile 5/6/10/11 pentruabstractaccountși codul 21 pentrupqc; începând cu 0.10.0 numește și un refuz care sosește ca text în timpul simulării taxei). - Semnare eth-native (0.6.0):
signClassicalEth,signHybridEth(secp256k1 pestekeccak256(SignDoc), tipul de cheie publică/cosmos.evm.crypto.v1.ethsecp256k1.PubKey, plus extensia hibridă ML-DSA-87),EthNativeSigner,accountAuthInfo. - Benzi de autentificatori (0.7.0): compozitori de mesaje
msg.abstractaccount.registerAuthenticator/revokeAuthenticator/executeEvm/executeCosmosși rotațiamsg.pqc(exportate și independent caexecuteEvmMsg,executeCosmosMsg,registerEthAuthenticatorMsg,revokeAuthenticatorMsg,rotatePqcKeyMsg); octeți de semnare exacți la nivel de byteevmAuthSignBytes,cosmosAuthSignBytes,rotationSignBytes; constructori pentru portofelebuildPhantomExecuteEvm/buildPhantomExecuteCosmos(signMessageed25519) șibuildMetaMaskExecuteEvm/buildMetaMaskExecuteCosmos(personal_signEIP-191); rotația cheilorrotatePqcKeyMsgFromMnemonic,derivePqcLegacy. Consultați ghidul Authenticators (modulul din spatele acestor benzi este dezactivat pe mainnet și activat pe testnet). - Octeți de semnare hibrizi (0.8.0+): opțiunea
signBytesVersion("auto" | "v1" | "v2") labuildHybridTx,signAndBroadcastHybrid,signHybridEthșiEthNativeSigner;resolveSignBytesVersion,SIGN_BYTES_V2_UPGRADES,isHybridSignBytesRejection,hybridSignBytesV1/hybridSignBytesV2,migrationSignBytes,bridgeAttestationSignBytes. - Fereastra de autorizare EVM (0.8.2+):
openEvmWindowMsg(nativeOnlyșiallowedTargetsîncepând cu 0.9.0),closeEvmWindowMsg,fetchEvmWindow,classifyEvmWindowRejection,isEvmWindowRejection,MAX_EVM_WINDOW_BLOCKS,MAX_EVM_WINDOW_TXS,MAX_EVM_WINDOW_TARGETS. Vezi Fereastra de autorizare EVM. - Consimțământ EIP-7702 (0.9.0):
authorizeEvmDelegationMsg,clearEvmDelegationMsg,fetchEvmDelegationConsent,evmDelegationTupleNonce,classifyEvmDelegationRejection,EVM_DELEGATION_CLEAR,MAX_EVM_DELEGATION_CONSENT_BLOCKS. - Digest v2 pentru abstract account (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;possessionProvenpe starea PQC;ibcTimeoutTimestamp;CHAIN_UPGRADE_V3_2_4. Vezi Ce a adăugat 0.10.0. - Chain v3.2.5 (0.12.0): registrul de chei ML-KEM-1024 (
msg.pqc.registerKemKey/removeKemKey,validateKemPublicKey,fetchKemKey,parseKemKey,KEM_ALGORITHM_ML_KEM_1024,ML_KEM_1024_PUBLIC_KEY_SIZE); gaz exact pentru tranzacțiile hibride (exactHybridGas,EXACT_GAS_MULTIPLIER,EXACT_GAS_HEADROOM,TxClient.estimateGasDetails); citiri abstract-account (fetchSpendingRules,fetchAuthenticators) șimsg.abstractaccount.updateConfig; constructori verificați pentru parametrii de guvernanță (validateCrossVmUpdateParams,validateRdkUpdateParams);CHAIN_UPGRADE_V3_2_5; presetarealocalnet. Vezi Ce adaugă 0.12.0. - Derivare PQC canonică (0.8.3+):
derivePqcCanonical(account, mnemonic),canonicalAccount(account); mesajul de înregistrare PQC estebuildRegisterPqcKeyMsg(folosit deensurePqcRegistered).derivePqcLegacyeste depreciat pentru chei noi.
@qorechain/evm
createEvmClient, evmAccountFromPrivateKey, funcțiile ajutătoare erc20,
wrapper-ele de contracte (deployContract, readContract, writeContract),
bindingurile precompiles, funcțiile ajutătoare bazate pe precompile
simulateWithRiskScore, aiRiskScore și aiAnomalyCheck,
PRECOMPILE_ADDRESSES și ABI-urile (ERC20_ABI, IQORE_PQC_ABI,
IQORE_AI_ABI, IQORE_CONSENSUS_ABI). Bindingurile și funcțiile ajutătoare
bazate pe precompile nu sunt active pe rețelele publice (vezi
Precompile-uri EVM).
@qorechain/svm
createSvmClient, DEFAULT_SVM_RPC_URL, svmKeypairFromSecretKey,
svmAddress, constructorii de programe (createMemoInstruction,
createTransferTokenInstruction, createAssociatedTokenAccountInstruction,
getAssociatedTokenAddress, createInvokeInstruction) și constantele
program-id.
Alte limbaje
| Limbaj | Documentație generată | Instalare |
|---|---|---|
| Python | PyPI — docstring-uri pe API-ul public | pip install qorechain-sdk la 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 | Javadoc pe Maven Central | io.github.qorechain:qorechain-sdk:0.14.0 |
Fiecare pachet oglindește aceeași suprafață (preseturi de rețea, utilitare
denom/adrese, derivare HD — inclusiv conturi unificate eth-native — primitive
PQC și semnare hibridă, mesaje și interogări tipizate, benzile de
autentificatori și clienți de citire REST + JSON-RPC qor_), documentată
inline în sursă, astfel încât instrumentele de documentare native fiecărui
limbaj să o poată reda. Constructorii de portofele din TypeScript
(buildPhantom* / buildMetaMask*) și adaptoarele pentru portofele de
browser sunt disponibile doar în TypeScript.