APIリファレンス
TypeScript(@qorechain/sdk)
TypeScriptパッケージは公開APIサーフェス全体に完全なTSDocを同梱しており、コアパッケージにはTypeDocの設定が組み込まれています。@qorechain/sdkのHTML版APIリファレンスを生成するには、次を実行します。
# from the monorepo root
pnpm --filter @qorechain/sdk docs:api
これはpackages/tsで定義されているdocs:apiスクリプト(typedoc)を実行し、当該パッケージのdocs/出力ディレクトリ配下にAPIサイトを生成します。生成された出力はコミットされません — コマンドをローカルで実行するか、独自のドキュメントパイプラインに組み込んでください。
ドキュメントサイト自体のTypeDoc設定はdocs/typedoc.jsonにあります。コアパッケージのエントリポイントを指しているため、docsプロジェクト側からも再生成できます。
公開サーフェスの概要
@qorechain/sdkが意図的にサポートしているエクスポートは次のとおりです。
- クライアント:
createClient、型QoreChainClient、CreateClientOptions、ConnectTxOptions、ClientFees。 - ネットワーク: プリセット、検索/一覧ヘルパー、および設定型(networksモジュール)。
- ユーティリティ:
toBase/fromBase(denom)、アドレスのエンコード/検証。 - アカウント:
generateMnemonic、validateMnemonic、deriveNativeAccount、deriveEvmAccount、deriveSvmAccount、およびアカウント型。 - 統合アカウント(0.6.0):
deriveUnifiedAccount、unifiedAccountFromSeed(0.13.0:QRC1のリカバリーコードまたは独立した 32 バイトの PQC シークレットが必要)、addressesFrom20、qoreAddresses、およびQRC1リカバリーコードのヘルパーgeneratePqcRecoveryCode、isValidRecoveryCode、normalizeRecoveryCode、pqcKeyFromRecoveryCode、pqcRecoveryCodeFromSecret。(unifiedAccountFromPhantomSignatureとconnectPhantomUnifiedは 0.8.0 で削除され、例外を投げます。) - PQC:
generatePqcKeypair、pqcSign、pqcVerify、長さ定数、 アルゴリズムID/ヘルパー、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)。 - 読み取りクライアント:
RestClient(getPermissionSchemaを含む)、JsonRpcClient、QorClient、HTTPヘルパー(getJson、postJsonRpc、buildUrl、joinUrl、QoreHttpError)。また、amm、license、abstractaccount(permissionSchema)を含む全モジュールの型付きクエリ クライアント、およびmultilayerのAnchor/Anchorsステートアンカー クエリ。公開エンドポイントでは、型付きRESTヘルパーの一部が、ゲートウェイが 提供していないルートを呼び出します。getAiStats、getFeeEstimate、getXqorePosition、getInflationRate、getReputation。getBurnStats、getAllBalances、getBridgeChains、getPermissionSchema、 および(0.9.0 以降。0.9.0 で複数形のaccountsパスが、提供されている 単数形の/qorechain/pqc/v1/account/{address}に修正されました)getPqcAccountは動作します。 - クロスVM:
getCrossVmMessage、getPendingCrossVmMessages、getCrossVmParams。 - QoreChain Native:
createCosmWasmClient、connectCosmWasmSigner、queryContractSmart、getContractInfo、instantiate、execute、uploadCode。 - トランザクション:
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(keccak256(SignDoc)に対するsecp256k1、公開鍵タイプ/cosmos.evm.crypto.v1.ethsecp256k1.PubKey、さらにML-DSA-87ハイブリッド 拡張を付加)、EthNativeSigner、accountAuthInfo。 - オーセンティケータレーン(0.7.0): メッセージコンポーザ
msg.abstractaccount.registerAuthenticator/revokeAuthenticator/executeEvm/executeCosmosおよびmsg.pqcローテーション (executeEvmMsg、executeCosmosMsg、registerEthAuthenticatorMsg、revokeAuthenticatorMsg、rotatePqcKeyMsgとして単体でもエクスポート)。バイト単位で正確な 署名バイト列evmAuthSignBytes、cosmosAuthSignBytes、rotationSignBytes。ウォレットビルダーbuildPhantomExecuteEvm/buildPhantomExecuteCosmos(ed25519signMessage)およびbuildMetaMaskExecuteEvm/buildMetaMaskExecuteCosmos(EIP-191personal_sign)。鍵ローテーションrotatePqcKeyMsgFromMnemonic、derivePqcLegacy。詳細は オーセンティケータガイドを参照してください (これらのレーンの基盤となるモジュールは、メインネットでは無効で、テストネットでは有効です)。 - ハイブリッド署名バイト列(0.8.0+):
buildHybridTx、signAndBroadcastHybrid、signHybridEth、EthNativeSignerのsignBytesVersionオプション ("auto" | "v1" | "v2")。resolveSignBytesVersion、SIGN_BYTES_V2_UPGRADES、isHybridSignBytesRejection、hybridSignBytesV1/hybridSignBytesV2、migrationSignBytes、bridgeAttestationSignBytes。 - EVM認可ウィンドウ(0.8.2+):
openEvmWindowMsg(0.9.0 からnativeOnlyとallowedTargets)、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): Staking Tier(
msg.stakingtier.lockDelegation/unlockEarly/claimBonus/updateParams、validateLockDelegation、STAKING_LOCK_MONTHS、fetchStakingTierParams、fetchStakingLocks、fetchStakingTierPool)、fetchAuthNonce、fetchProtocolFeatures/isProtocolFeatureEnabled、PQC ステータスのpossessionProven、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バインディング、プリコンパイルを基盤とするヘルパーsimulateWithRiskScore、aiRiskScore、aiAnomalyCheck、PRECOMPILE_ADDRESSES、および各種ABI(ERC20_ABI、IQORE_PQC_ABI、IQORE_AI_ABI、IQORE_CONSENSUS_ABI)。プリコンパイルを基盤とするバインディングとヘルパーは、公開ネットワークでは有効ではありません(EVMプリコンパイルを参照)。
@qorechain/svm
createSvmClient、DEFAULT_SVM_RPC_URL、svmKeypairFromSecretKey、svmAddress、プログラムビルダー(createMemoInstruction、createTransferTokenInstruction、createAssociatedTokenAccountInstruction、getAssociatedTokenAddress、createInvokeInstruction)、およびプログラムID定数。
その他の言語
| 言語 | 生成ドキュメント | インストール |
|---|---|---|
| Python | PyPI — 公開APIにdocstringを完備 | pip install qorechain-sdk(バージョン0.14.0、インポート名はqorsdk) |
| Go | pkg.go.dev(godoc) | go get github.com/qorechain/qorechain-sdk/packages/go/...@v0.14.0(タグ packages/go/v0.14.0) |
| Rust | docs.rs(rustdoc) | cargo add qorechain-sdk(0.14.0、インポート名はqorechain) |
| Java | Maven Central のjavadoc | io.github.qorechain:qorechain-sdk:0.14.0 |
各パッケージは同一のサーフェス(ネットワークプリセット、denom/アドレスユーティリティ、HD導出 — 統合ethネイティブアカウントを含む — PQCプリミティブとハイブリッド署名、型付きメッセージとクエリ、オーセンティケータレーン、REST + qor_ JSON-RPC読み取りクライアント)を提供し、各言語ネイティブのドキュメントツールでレンダリングされるようソース内にインラインで文書化されています。TypeScriptのウォレットビルダー(buildPhantom* / buildMetaMask*)とブラウザウォレットアダプタはTypeScript専用です。