إنتقل إلى المحتوى الرئيسي

مرجع API

TypeScript (@qorechain/sdk)​

تأتي حزم TypeScript مع توثيق TSDoc كامل لواجهتها العامة، كما أن إعدادات TypeDoc مهيّأة داخل الحزمة الأساسية. لتوليد مرجع API بصيغة HTML للحزمة @qorechain/sdk:

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

يشغّل هذا الأمر السكربت docs:api (المعتمد على typedoc) المعرَّف في packages/ts، منتجًا موقع الـ API ضمن دليل المخرجات docs/ الخاص بتلك الحزمة. المخرجات المولَّدة لا يتم إيداعها في المستودع — شغِّل الأمر محليًا أو ادمجه في خط أنابيب التوثيق الخاص بك.

يوجد إعداد TypeDoc الخاص بموقع التوثيق نفسه في docs/typedoc.json؛ وهو يشير إلى نقطة الدخول الخاصة بالحزمة الأساسية بحيث يمكنك إعادة التوليد من مشروع التوثيق أيضًا.

نظرة سريعة على الواجهة العامة​

الصادرات المدعومة والمقصودة من @qorechain/sdk:

  • العميل (Client): ‏createClient، والأنواع QoreChainClient، CreateClientOptions، ConnectTxOptions، ClientFees.
  • الشبكات (Networks): الإعدادات المسبقة، ودوال البحث/العرض المساعدة، وأنواع الإعدادات (وحدة الشبكات).
  • الأدوات المساعدة (Utilities): ‏toBase / fromBase (الفئة النقدية denom)، وترميز العناوين والتحقق منها.
  • الحسابات (Accounts): ‏generateMnemonic، validateMnemonic، deriveNativeAccount، deriveEvmAccount، deriveSvmAccount؛ وأنواع الحسابات.
  • الحسابات الموحّدة (0.6.0): ‏deriveUnifiedAccount، unifiedAccountFromSeed (0.13.0: تحتاج رمز استرداد QRC1 أو سر PQC مستقلًا من 32 بايتًا)، addressesFrom20، qoreAddresses، ودوال رمز الاسترداد QRC1: generatePqcRecoveryCode وisValidRecoveryCode وnormalizeRecoveryCode وpqcKeyFromRecoveryCode وpqcRecoveryCodeFromSecret. (أُزيلت unifiedAccountFromPhantomSignature وconnectPhantomUnified في الإصدار 0.8.0 وأصبحتا ترميان خطأ.)
  • PQC: ‏generatePqcKeypair، pqcSign، pqcVerify، وثوابت الأطوال، ومعرّفات الخوارزميات ودوالها المساعدة، PqcSigner، HybridSigner، buildHybridSignatureExtension، HYBRID_SIG_TYPE_URL.
  • دورة حياة مفتاح PQC (0.9.0): ‏ensurePqcRegistered (تقرأ الحالة عبر 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 (بما في ذلك getPermissionSchema)، JsonRpcClient، QorClient، ودوال HTTP المساعدة (getJson، postJsonRpc، buildUrl، joinUrl، QoreHttpError)؛ وعملاء استعلام منمّطون لكل وحدة، بما فيها amm وlicense وabstractaccount (‏permissionSchema)، واستعلامات مرساة الحالة Anchor/Anchors الخاصة بوحدة multilayer. على نقاط النهاية العامة تستدعي بعض دوال REST المنمّطة مسارات لا تقدّمها البوابة: getAiStats، getFeeEstimate، getXqorePosition، getInflationRate وgetReputation. أما getBurnStats وgetAllBalances وgetBridgeChains وgetPermissionSchema و(منذ 0.9.0، الذي أصلح مسارها بصيغة الجمع accounts إلى المسار المُقدَّم بصيغة المفرد /qorechain/pqc/v1/account/{address}) getPqcAccount فتعمل.
  • عبر الأجهزة الافتراضية (Cross-VM): ‏getCrossVmMessage، getPendingCrossVmMessages، getCrossVmParams.
  • QoreChain Native: ‏createCosmWasmClient، connectCosmWasmSigner، queryContractSmart، getContractInfo، instantiate، execute، uploadCode.
  • المعاملات (Transactions): ‏estimateFee، directSignerFromPrivateKey، TxClient (هجين عند الاتصال بـ pqcKeypair، 0.9.0؛ HYBRID_VERIFY_GAS)، MSG_SEND_TYPE_URL، والدوال الهجينة المساعدة (encodeHybridExtension، attachHybridExtension، buildHybridTx، signAndBroadcastHybrid)؛ وفكّ ترميز الأخطاء المهيكل عبر decodeTxError (بما في ذلك رموز abstractaccount ‏5/6/10/11 ورمز pqc ‏21؛ ومنذ 0.10.0 تسمّي أيضًا الرفض الذي يصل نصًّا أثناء محاكاة الرسوم).
  • التوقيع الأصيل بنمط eth ‏(0.6.0): ‏signClassicalEth، signHybridEth (‏secp256k1 فوق keccak256(SignDoc)، ونوع المفتاح العام /cosmos.evm.crypto.v1.ethsecp256k1.PubKey، إضافةً إلى امتداد ML-DSA-87 الهجين)، EthNativeSigner، accountAuthInfo.
  • مسارات المصادِقات (Authenticator lanes) ‏(0.7.0): مركّبات الرسائل msg.abstractaccount.registerAuthenticator / revokeAuthenticator / executeEvm / executeCosmos وتدوير msg.pqc (مصدَّرة أيضًا بشكل مستقل باسم executeEvmMsg، executeCosmosMsg، registerEthAuthenticatorMsg، revokeAuthenticatorMsg، rotatePqcKeyMsg)؛ وبايتات التوقيع المطابقة بايتًا ببايت evmAuthSignBytes، cosmosAuthSignBytes، rotationSignBytes؛ وبُناة المحافظ buildPhantomExecuteEvm / buildPhantomExecuteCosmos (‏ed25519 عبر signMessage) وbuildMetaMaskExecuteEvm / buildMetaMaskExecuteCosmos (‏EIP-191 عبر personal_sign)؛ وتدوير المفاتيح rotatePqcKeyMsgFromMnemonic، derivePqcLegacy. راجع دليل المصادِقات (الوحدة الكامنة وراء هذه المسارات متوقفة على الشبكة الرئيسية ومفعَّلة على شبكة الاختبار).
  • بايتات التوقيع الهجينة (Hybrid sign-bytes) ‏(0.8.0+): الخيار signBytesVersion (‏"auto" | "v1" | "v2") في buildHybridTx وsignAndBroadcastHybrid و signHybridEth وEthNativeSigner؛ وresolveSignBytesVersion، SIGN_BYTES_V2_UPGRADES، isHybridSignBytesRejection، hybridSignBytesV1 / hybridSignBytesV2، migrationSignBytes، bridgeAttestationSignBytes.
  • نافذة تفويض EVM ‏(0.8.2+): ‏openEvmWindowMsg (مع nativeOnly و allowedTargets منذ 0.9.0)، closeEvmWindowMsg، fetchEvmWindow، classifyEvmWindowRejection، isEvmWindowRejection، MAX_EVM_WINDOW_BLOCKS، MAX_EVM_WINDOW_TXS، MAX_EVM_WINDOW_TARGETS. راجع نافذة تفويض EVM.
  • موافقة EIP-7702 ‏(0.9.0): ‏authorizeEvmDelegationMsg، clearEvmDelegationMsg، fetchEvmDelegationConsent، evmDelegationTupleNonce، classifyEvmDelegationRejection، EVM_DELEGATION_CLEAR، MAX_EVM_DELEGATION_CONSENT_BLOCKS.
  • ملخّص الحساب المجرَّد v2 ‏(0.9.0): ‏evmAuthSignBytesV2، resolveEvmAuthDigestVersion؛ validateSpendingRules.
  • السلسلة v3.2.4 ‏(0.10.0): مستويات الرهن (msg.stakingtier.lockDelegation / unlockEarly / claimBonus / updateParams، validateLockDelegation، STAKING_LOCK_MONTHS، fetchStakingTierParams، fetchStakingLocks، fetchStakingTierPool)؛ وfetchAuthNonce؛ وfetchProtocolFeatures / isProtocolFeatureEnabled؛ وpossessionProven في حالة PQC؛ وibcTimeoutTimestamp؛ وCHAIN_UPGRADE_V3_2_4. راجع ما الذي أضافه 0.10.0.
  • السلسلة v3.2.5 ‏(0.12.0): سجل مفاتيح ML-KEM-1024 (msg.pqc.registerKemKey / removeKemKey، وvalidateKemPublicKey، وfetchKemKey، وparseKemKey، وKEM_ALGORITHM_ML_KEM_1024، وML_KEM_1024_PUBLIC_KEY_SIZE)؛ والغاز الدقيق للمعاملات الهجينة (exactHybridGas، وEXACT_GAS_MULTIPLIER، وEXACT_GAS_HEADROOM، وTxClient.estimateGasDetails)؛ وقراءات الحساب المجرّد (fetchSpendingRules، وfetchAuthenticators) وmsg.abstractaccount.updateConfig؛ وبُناة معاملات الحوكمة المفحوصون (validateCrossVmUpdateParams، وvalidateRdkUpdateParams)؛ وCHAIN_UPGRADE_V3_2_5؛ والإعداد المسبق localnet. راجع ما الذي يضيفه 0.12.0.
  • الاشتقاق القياسي لـ PQC ‏(0.8.3+): ‏derivePqcCanonical(account, mnemonic)، canonicalAccount(account)؛ ورسالة تسجيل PQC هي buildRegisterPqcKeyMsg (تستخدمها ensurePqcRegistered). derivePqcLegacy مهجورة للمفاتيح الجديدة.

@qorechain/evm​

‏createEvmClient، evmAccountFromPrivateKey، ودوال erc20 المساعدة، وأغلفة العقود (deployContract، readContract، writeContract)، وارتباطات precompiles، والدوال المساعدة المعتمدة على precompile ‏simulateWithRiskScore وaiRiskScore و aiAnomalyCheck، وPRECOMPILE_ADDRESSES، وواجهات ABI ‏(ERC20_ABI، IQORE_PQC_ABI، IQORE_AI_ABI، IQORE_CONSENSUS_ABI). الارتباطات والدوال المساعدة المعتمدة على precompile غير مفعّلة على الشبكات العامة (راجع عقود EVM المسبقة التجميع).

@qorechain/svm​

‏createSvmClient، DEFAULT_SVM_RPC_URL، svmKeypairFromSecretKey، svmAddress، وبُناة البرامج (createMemoInstruction، createTransferTokenInstruction، createAssociatedTokenAccountInstruction، getAssociatedTokenAddress، createInvokeInstruction)، وثوابت معرّفات البرامج.

اللغات الأخرى​

اللغةالتوثيق المولَّدالتثبيت
PythonPyPI — توثيق docstrings على واجهة الـ API العامةpip install qorechain-sdk بالإصدار 0.14.0 (الاستيراد qorsdk)
Gopkg.go.dev (‏godoc)go get github.com/qorechain/qorechain-sdk/packages/go/...@v0.14.0 (الوسم packages/go/v0.14.0)
Rustdocs.rs (‏rustdoc)cargo add qorechain-sdk (0.14.0؛ الاستيراد qorechain)
Javaتوثيق javadoc على Maven Centralio.github.qorechain:qorechain-sdk:0.14.0

كل حزمة تعكس الواجهة نفسها (الإعدادات المسبقة للشبكات، وأدوات الفئات النقدية/العناوين، والاشتقاق الهرمي الحتمي HD — بما في ذلك الحسابات الموحّدة الأصيلة بنمط eth — وأساسيات PQC والتوقيع الهجين، والرسائل والاستعلامات المنمّطة، ومسارات المصادِقات، وعملاء القراءة عبر REST و‏JSON-RPC ذات البادئة qor_)، موثَّقةً داخل الشيفرة المصدرية بحيث تعرضها أدوات التوثيق الأصيلة لكل لغة. أما بُناة المحافظ في TypeScript ‏(buildPhantom* / buildMetaMask*) ومحوّلات محافظ المتصفح فهي متاحة في TypeScript فقط.