Riferimento API
TypeScript (@qorechain/sdk)
I pacchetti TypeScript includono TSDoc completo su tutta la loro superficie
pubblica, e una configurazione TypeDoc è integrata nel
pacchetto core. Per generare il riferimento API in HTML per @qorechain/sdk:
# from the monorepo root
pnpm --filter @qorechain/sdk docs:api
Questo esegue lo script docs:api (typedoc) definito in packages/ts,
producendo il sito API nella directory di output docs/ di quel pacchetto.
L'output generato non viene committato — esegui il comando in locale oppure
integralo nella tua pipeline di documentazione.
La configurazione TypeDoc del sito di documentazione stesso si trova in
docs/typedoc.json; punta all'entry point del pacchetto core, quindi puoi
rigenerare anche dal progetto docs.
La superficie pubblica in sintesi
Gli export deliberati e supportati di @qorechain/sdk:
- Client:
createClient, i tipiQoreChainClient,CreateClientOptions,ConnectTxOptions,ClientFees. - Reti: preset, helper di ricerca/elenco e tipi di configurazione (modulo networks).
- Utility:
toBase/fromBase(denom), codifica/validazione degli indirizzi. - Account:
generateMnemonic,validateMnemonic,deriveNativeAccount,deriveEvmAccount,deriveSvmAccount; tipi di account. - Account unificati (0.6.0):
deriveUnifiedAccount,unifiedAccountFromSeed(0.13.0: richiede un codice di recuperoQRC1o un segreto PQC indipendente di 32 byte),addressesFrom20,qoreAddresses, e gli helper dei codici di recuperoQRC1generatePqcRecoveryCode,isValidRecoveryCode,normalizeRecoveryCode,pqcKeyFromRecoveryCode,pqcRecoveryCodeFromSecret. (unifiedAccountFromPhantomSignatureeconnectPhantomUnifiedsono state rimosse nella 0.8.0 e lanciano un errore.) - PQC:
generatePqcKeypair,pqcSign,pqcVerify, costanti di lunghezza, ID/helper degli algoritmi,PqcSigner,HybridSigner,buildHybridSignatureExtension,HYBRID_SIG_TYPE_URL. - Ciclo di vita della chiave PQC (0.9.0):
ensurePqcRegistered(legge lo stato via 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). - Client di lettura:
RestClient(incl.getPermissionSchema),JsonRpcClient,QorClient, helper HTTP (getJson,postJsonRpc,buildUrl,joinUrl,QoreHttpError); client di query tipizzati per ogni modulo, inclusiamm,license,abstractaccount(permissionSchema) e le query di state-anchorAnchor/Anchorsdel modulomultilayer. Sugli endpoint pubblici alcuni helper REST tipizzati chiamano route che il gateway non serve:getAiStats,getFeeEstimate,getXqorePosition,getInflationRateegetReputation.getBurnStats,getAllBalances,getBridgeChains,getPermissionSchemae (dalla 0.9.0, che ha corretto il suo percorsoaccountsal plurale nel percorso singolare servito/qorechain/pqc/v1/account/{address})getPqcAccountfunzionano. - Cross-VM:
getCrossVmMessage,getPendingCrossVmMessages,getCrossVmParams. - QoreChain Native:
createCosmWasmClient,connectCosmWasmSigner,queryContractSmart,getContractInfo,instantiate,execute,uploadCode. - Transazioni:
estimateFee,directSignerFromPrivateKey,TxClient(ibrido quando connesso conpqcKeypair, 0.9.0;HYBRID_VERIFY_GAS),MSG_SEND_TYPE_URL, helper ibridi (encodeHybridExtension,attachHybridExtension,buildHybridTx,signAndBroadcastHybrid); decodifica strutturata degli errori tramitedecodeTxError(incl. i codiciabstractaccount5/6/10/11 e il codicepqc21; dalla 0.10.0 nomina anche un rifiuto che arriva come testo durante la simulazione della commissione). - Firma eth-native (0.6.0):
signClassicalEth,signHybridEth(secp256k1 sukeccak256(SignDoc), tipo di pubkey/cosmos.evm.crypto.v1.ethsecp256k1.PubKey, più l'estensione ibrida ML-DSA-87),EthNativeSigner,accountAuthInfo. - Corsie authenticator (0.7.0): compositori di messaggi
msg.abstractaccount.registerAuthenticator/revokeAuthenticator/executeEvm/executeCosmose la rotazionemsg.pqc(esportati anche in forma standalone comeexecuteEvmMsg,executeCosmosMsg,registerEthAuthenticatorMsg,revokeAuthenticatorMsg,rotatePqcKeyMsg); sign-bytes byte-esattievmAuthSignBytes,cosmosAuthSignBytes,rotationSignBytes; builder per walletbuildPhantomExecuteEvm/buildPhantomExecuteCosmos(signMessageed25519) ebuildMetaMaskExecuteEvm/buildMetaMaskExecuteCosmos(personal_signEIP-191); rotazione delle chiavirotatePqcKeyMsgFromMnemonic,derivePqcLegacy. Vedi la guida agli Authenticator (il modulo alla base di queste corsie è disattivato sulla mainnet e abilitato sulla testnet). - Sign-bytes ibridi (0.8.0+): l'opzione
signBytesVersion("auto" | "v1" | "v2") subuildHybridTx,signAndBroadcastHybrid,signHybridEtheEthNativeSigner;resolveSignBytesVersion,SIGN_BYTES_V2_UPGRADES,isHybridSignBytesRejection,hybridSignBytesV1/hybridSignBytesV2,migrationSignBytes,bridgeAttestationSignBytes. - Finestra di autorizzazione EVM (0.8.2+):
openEvmWindowMsg(nativeOnlyeallowedTargetsdalla 0.9.0),closeEvmWindowMsg,fetchEvmWindow,classifyEvmWindowRejection,isEvmWindowRejection,MAX_EVM_WINDOW_BLOCKS,MAX_EVM_WINDOW_TXS,MAX_EVM_WINDOW_TARGETS. Vedi Finestra di autorizzazione EVM. - Consenso EIP-7702 (0.9.0):
authorizeEvmDelegationMsg,clearEvmDelegationMsg,fetchEvmDelegationConsent,evmDelegationTupleNonce,classifyEvmDelegationRejection,EVM_DELEGATION_CLEAR,MAX_EVM_DELEGATION_CONSENT_BLOCKS. - Digest v2 dell'abstract account (0.9.0):
evmAuthSignBytesV2,resolveEvmAuthDigestVersion;validateSpendingRules. - Chain v3.2.4 (0.10.0): staking tier (
msg.stakingtier.lockDelegation/unlockEarly/claimBonus/updateParams,validateLockDelegation,STAKING_LOCK_MONTHS,fetchStakingTierParams,fetchStakingLocks,fetchStakingTierPool);fetchAuthNonce;fetchProtocolFeatures/isProtocolFeatureEnabled;possessionProvensullo stato PQC;ibcTimeoutTimestamp;CHAIN_UPGRADE_V3_2_4. Vedi Cosa ha aggiunto la 0.10.0. - Chain v3.2.5 (0.12.0): il registro delle chiavi ML-KEM-1024 (
msg.pqc.registerKemKey/removeKemKey,validateKemPublicKey,fetchKemKey,parseKemKey,KEM_ALGORITHM_ML_KEM_1024,ML_KEM_1024_PUBLIC_KEY_SIZE); gas esatto per le transazioni ibride (exactHybridGas,EXACT_GAS_MULTIPLIER,EXACT_GAS_HEADROOM,TxClient.estimateGasDetails); letture degli account astratti (fetchSpendingRules,fetchAuthenticators) emsg.abstractaccount.updateConfig; builder verificati dei parametri di governance (validateCrossVmUpdateParams,validateRdkUpdateParams);CHAIN_UPGRADE_V3_2_5; il presetlocalnet. Vedi Cosa aggiunge la 0.12.0. - Derivazione PQC canonica (0.8.3+):
derivePqcCanonical(account, mnemonic),canonicalAccount(account); il messaggio di registrazione PQC èbuildRegisterPqcKeyMsg(usato daensurePqcRegistered).derivePqcLegacyè deprecata per le nuove chiavi.
@qorechain/evm
createEvmClient, evmAccountFromPrivateKey, gli helper erc20, i wrapper
per contratti (deployContract, readContract, writeContract), i binding
precompiles, gli helper basati sui precompile simulateWithRiskScore,
aiRiskScore e aiAnomalyCheck, PRECOMPILE_ADDRESSES e le ABI
(ERC20_ABI, IQORE_PQC_ABI, IQORE_AI_ABI, IQORE_CONSENSUS_ABI). I
binding e gli helper basati sui precompile non sono attivi sulle reti
pubbliche (vedi
Precompile EVM).
@qorechain/svm
createSvmClient, DEFAULT_SVM_RPC_URL, svmKeypairFromSecretKey,
svmAddress, i builder di programmi (createMemoInstruction,
createTransferTokenInstruction, createAssociatedTokenAccountInstruction,
getAssociatedTokenAddress, createInvokeInstruction) e le costanti dei
program-id.
Altri linguaggi
| Linguaggio | Documentazione generata | Installazione |
|---|---|---|
| Python | PyPI — docstring sull'API pubblica | pip install qorechain-sdk alla 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 su Maven Central | io.github.qorechain:qorechain-sdk:0.14.0 |
Ogni pacchetto rispecchia la stessa superficie (preset di rete, utility per
denom/indirizzi, derivazione HD — inclusi gli account unificati eth-native —
primitive PQC e firma ibrida, messaggi e query tipizzati, le corsie
authenticator e client di lettura REST + JSON-RPC qor_), documentata inline
nel sorgente così che il tooling di documentazione nativo di ciascun linguaggio
possa renderizzarla. I builder per wallet TypeScript (buildPhantom* /
buildMetaMask*) e gli adapter per browser-wallet sono disponibili solo in
TypeScript.