Saltar al contenido principal

Referencia de la API

TypeScript (@qorechain/sdk)​

Los paquetes de TypeScript incluyen TSDoc completo en su superficie pública, y el paquete principal trae integrada una configuración de TypeDoc. Para generar la referencia HTML de la API de @qorechain/sdk:

# from the monorepo root
pnpm --filter @qorechain/sdk docs:api

Esto ejecuta el script docs:api (typedoc) definido en packages/ts, y produce el sitio de la API bajo el directorio de salida docs/ de ese paquete. La salida generada no se versiona en el repositorio: ejecuta el comando en local o intégralo en tu propio pipeline de documentación.

La configuración de TypeDoc propia del sitio de documentación vive en docs/typedoc.json; apunta al punto de entrada del paquete principal, de modo que también puedes regenerarla desde el proyecto de documentación.

La superficie pública de un vistazo​

Las exportaciones deliberadas y soportadas de @qorechain/sdk:

  • Cliente: createClient, tipos QoreChainClient, CreateClientOptions, ConnectTxOptions, ClientFees.
  • Redes: presets, helpers de búsqueda/listado y tipos de configuración (módulo de redes).
  • Utilidades: toBase / fromBase (denom), codificación/validación de direcciones.
  • Cuentas: generateMnemonic, validateMnemonic, deriveNativeAccount, deriveEvmAccount, deriveSvmAccount; tipos de cuenta.
  • Cuentas unificadas (0.6.0): deriveUnifiedAccount, unifiedAccountFromSeed (0.13.0: necesita un código de recuperación QRC1 o un secreto PQC independiente de 32 bytes), addressesFrom20, qoreAddresses, y los ayudantes de códigos de recuperación QRC1 generatePqcRecoveryCode, isValidRecoveryCode, normalizeRecoveryCode, pqcKeyFromRecoveryCode, pqcRecoveryCodeFromSecret. (unifiedAccountFromPhantomSignature y connectPhantomUnified se eliminaron en 0.8.0 y lanzan un error.)
  • PQC: generatePqcKeypair, pqcSign, pqcVerify, constantes de longitud, IDs/helpers de algoritmos, PqcSigner, HybridSigner, buildHybridSignatureExtension, HYBRID_SIG_TYPE_URL.
  • Ciclo de vida de la clave PQC (0.9.0): ensurePqcRegistered (lee el estado por 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).
  • Clientes de lectura: RestClient (incl. getPermissionSchema), JsonRpcClient, QorClient, helpers HTTP (getJson, postJsonRpc, buildUrl, joinUrl, QoreHttpError); clientes de consulta tipados para cada módulo, incluidos amm, license, abstractaccount (permissionSchema) y las consultas de anclaje de estado Anchor/Anchors del módulo multilayer. En los endpoints públicos, algunos helpers REST tipados llaman a rutas que el gateway no sirve: getAiStats, getFeeEstimate, getXqorePosition, getInflationRate y getReputation. getBurnStats, getAllBalances, getBridgeChains, getPermissionSchema y (desde la 0.9.0, que corrigió su ruta accounts en plural por la singular servida /qorechain/pqc/v1/account/{address}) getPqcAccount funcionan.
  • Cross-VM: getCrossVmMessage, getPendingCrossVmMessages, getCrossVmParams.
  • QoreChain Native: createCosmWasmClient, connectCosmWasmSigner, queryContractSmart, getContractInfo, instantiate, execute, uploadCode.
  • Transacciones: estimateFee, directSignerFromPrivateKey, TxClient (híbrido cuando se conecta con pqcKeypair, 0.9.0; HYBRID_VERIFY_GAS), MSG_SEND_TYPE_URL, helpers híbridos (encodeHybridExtension, attachHybridExtension, buildHybridTx, signAndBroadcastHybrid); decodificación estructurada de errores mediante decodeTxError (incl. los códigos 5/6/10/11 de abstractaccount y el código 21 de pqc; desde la 0.10.0 también nombra un rechazo que llega como texto durante la simulación de comisiones).
  • Firma eth-native (0.6.0): signClassicalEth, signHybridEth (secp256k1 sobre keccak256(SignDoc), tipo de pubkey /cosmos.evm.crypto.v1.ethsecp256k1.PubKey, más la extensión híbrida ML-DSA-87), EthNativeSigner, accountAuthInfo.
  • Lanes de autenticadores (0.7.0): compositores de mensajes msg.abstractaccount.registerAuthenticator / revokeAuthenticator / executeEvm / executeCosmos y la rotación msg.pqc (también exportados de forma independiente como executeEvmMsg, executeCosmosMsg, registerEthAuthenticatorMsg, revokeAuthenticatorMsg, rotatePqcKeyMsg); sign-bytes exactos a nivel de byte evmAuthSignBytes, cosmosAuthSignBytes, rotationSignBytes; builders de wallet buildPhantomExecuteEvm / buildPhantomExecuteCosmos (signMessage ed25519) y buildMetaMaskExecuteEvm / buildMetaMaskExecuteCosmos (personal_sign EIP-191); rotación de claves rotatePqcKeyMsgFromMnemonic, derivePqcLegacy. Consulta la guía de Authenticators (el módulo que hay tras estas lanes está desactivado en mainnet y activado en la testnet).
  • Sign-bytes híbridos (0.8.0+): la opción signBytesVersion ("auto" | "v1" | "v2") en buildHybridTx, signAndBroadcastHybrid, signHybridEth y EthNativeSigner; resolveSignBytesVersion, SIGN_BYTES_V2_UPGRADES, isHybridSignBytesRejection, hybridSignBytesV1 / hybridSignBytesV2, migrationSignBytes, bridgeAttestationSignBytes.
  • Ventana de autorización EVM (0.8.2+): openEvmWindowMsg (nativeOnly y allowedTargets desde la 0.9.0), closeEvmWindowMsg, fetchEvmWindow, classifyEvmWindowRejection, isEvmWindowRejection, MAX_EVM_WINDOW_BLOCKS, MAX_EVM_WINDOW_TXS, MAX_EVM_WINDOW_TARGETS. Consulta Ventana de autorización EVM.
  • Consentimiento EIP-7702 (0.9.0): authorizeEvmDelegationMsg, clearEvmDelegationMsg, fetchEvmDelegationConsent, evmDelegationTupleNonce, classifyEvmDelegationRejection, EVM_DELEGATION_CLEAR, MAX_EVM_DELEGATION_CONSENT_BLOCKS.
  • Digest v2 de cuenta abstracta (0.9.0): evmAuthSignBytesV2, resolveEvmAuthDigestVersion; validateSpendingRules.
  • Cadena v3.2.4 (0.10.0): niveles de staking (msg.stakingtier.lockDelegation / unlockEarly / claimBonus / updateParams, validateLockDelegation, STAKING_LOCK_MONTHS, fetchStakingTierParams, fetchStakingLocks, fetchStakingTierPool); fetchAuthNonce; fetchProtocolFeatures / isProtocolFeatureEnabled; possessionProven en el estado PQC; ibcTimeoutTimestamp; CHAIN_UPGRADE_V3_2_4. Consulta Qué añadió la 0.10.0.
  • Cadena v3.2.5 (0.12.0): el registro de claves ML-KEM-1024 (msg.pqc.registerKemKey / removeKemKey, validateKemPublicKey, fetchKemKey, parseKemKey, KEM_ALGORITHM_ML_KEM_1024, ML_KEM_1024_PUBLIC_KEY_SIZE); gas exacto para transacciones híbridas (exactHybridGas, EXACT_GAS_MULTIPLIER, EXACT_GAS_HEADROOM, TxClient.estimateGasDetails); lecturas de cuentas abstractas (fetchSpendingRules, fetchAuthenticators) y msg.abstractaccount.updateConfig; constructores verificados de parámetros de gobernanza (validateCrossVmUpdateParams, validateRdkUpdateParams); CHAIN_UPGRADE_V3_2_5; el preajuste localnet. Consulta Qué añade la 0.12.0.
  • Derivación PQC canónica (0.8.3+): derivePqcCanonical(account, mnemonic), canonicalAccount(account); el mensaje de registro PQC es buildRegisterPqcKeyMsg (usado por ensurePqcRegistered). derivePqcLegacy está obsoleto para claves nuevas.

@qorechain/evm​

createEvmClient, evmAccountFromPrivateKey, los helpers erc20, los wrappers de contratos (deployContract, readContract, writeContract), los bindings de precompiles, los helpers respaldados por precompiles simulateWithRiskScore, aiRiskScore y aiAnomalyCheck, PRECOMPILE_ADDRESSES y las ABIs (ERC20_ABI, IQORE_PQC_ABI, IQORE_AI_ABI, IQORE_CONSENSUS_ABI). Los bindings y helpers respaldados por precompiles no están activos en las redes públicas (consulta Precompiles EVM).

@qorechain/svm​

createSvmClient, DEFAULT_SVM_RPC_URL, svmKeypairFromSecretKey, svmAddress, los builders de programas (createMemoInstruction, createTransferTokenInstruction, createAssociatedTokenAccountInstruction, getAssociatedTokenAddress, createInvokeInstruction) y las constantes de program-id.

Otros lenguajes​

LenguajeDocumentación generadaInstalación
PythonPyPI — docstrings en la API públicapip install qorechain-sdk en 0.14.0 (importa qorsdk)
Gopkg.go.dev (godoc)go get github.com/qorechain/qorechain-sdk/packages/go/...@v0.14.0 (tag packages/go/v0.14.0)
Rustdocs.rs (rustdoc)cargo add qorechain-sdk (0.14.0; importa qorechain)
JavaJavadoc en Maven Centralio.github.qorechain:qorechain-sdk:0.14.0

Cada paquete replica la misma superficie (presets de red, utilidades de denom/direcciones, derivación HD — incluidas las cuentas unificadas eth-native —, primitivas PQC y firma híbrida, mensajes y consultas tipados, las lanes de autenticadores, y clientes de lectura REST + JSON-RPC qor_), documentada de forma inline en el código fuente para que las herramientas de documentación nativas de cada lenguaje la rendericen. Los builders de wallet de TypeScript (buildPhantom* / buildMetaMask*) y los adaptadores de wallets de navegador son exclusivos de TypeScript.