XChain 平台 - 软件开发者 Kit (SDK)

SDK 用于 XChain 平台: 生成 XChain 交易并查询块链数据.

特征

• 31 行动类型数字 : sdk.send(), (中文(简体) ), sdk.issue(), (中文(简体) ), sdk.mint(), (中文(简体) ), sdk.stake(),还有27个方便方法
• 交易周期数字 : sdk.submitAction() 在一个呼叫中处理完整编码 - > 标志 - > 广播 - > 等待管道
• 钱包会话数字 : sdk.session(wif) 组合地址/关键/UTXO状态,用于一个地址的重复行动
• 费用估计数字 : sdk.estimateFees() 不签名或广播的返回费信息
• UTXO 链式: 内置的 UTXO 缓存可防止在快速相继交易上重复花费
• 工作流程配方数字 : sdk.issueAndDistribute(), (中文(简体) ), sdk.deployAndFund(), (中文(简体) ), sdk.stakeAndDelegate()和更多
• 跨链助手:协调跨 BTC、LTC 和 DOGE SDK 实例的互换和平行行动
• 事件驱动的确认数字 : sdk.waitForAction(txid) 当索引器处理交易时解决
• 合同结算门数字 : sdk.waitForContractState(index, { key: 'status', equals: 'FUNDED' }) 财务报告和审定财务报表 sdk.waitForContractBalance(index, tick, { minQuantity }) 等待合同本身的状态,这是唯一不能与索引者相竞争的信号; submitAction({ awaitContract: {...} }) 开同一扇门 所以在合同被记帐之前 押金不会回手控制
• 互动反应数字 : npm run repl 与预配置 SDK 实例一起跳入一个动态会话
• 自动选择格式: 为每个动作选择最小的编码格式
• PSBT 生成: 与 xchain- 编码器集成以生成未签名的交易
• 115+ 探索者查询方法: 余额、代号、交易、市场、历史、合同
• 批量构建器: 流畅的API : await sdk.batch().send({...}).mint({...}).build() (单位:千美元)build() 正在同步)
• 实时活动: WebSocket 有自动重联和接续的流经 onBlock(), (中文(简体) ), onAction(), (中文(简体) ), onAddress(), (中文(简体) ), onToken(), (中文(简体) ), onMarket(), (中文(简体) ), onDispenser(), (中文(简体) ), onBetFeed(), (中文(简体) ), onXcall(), (中文(简体) ), onAttestation()和更多; sdk.ws 曝光低端客户端( q)subscribe(), (中文(简体) ), on(), (中文(简体) ), listSubscriptions()直接(...)
• 加密信件ECIES、ECDH和AES加密MESSAGE行动; messaging.send() 接受一个 Buffer 有效载荷和 getMessages() 曝光情况 msg.bytes 二进制 ECIS
• 调制解析文件数字 : sdk.gatedFile.encryptFileBytes() 财务报告和审定财务报表 sdk.gatedFile.encryptPack() 生产AES-256-GCM Ciphertext + 密钥用于 FILE v1 闸口内容; 密钥交接作为紧凑的33字节二进制有效载荷通过 serializeKeyPayload() 编号 : parseKeyPayload() (以二进制模式通过ECIES发送). 见 调试内容
• 证明信封助手数字 : AttestationHelpers.llm({...}) 建造JSON信封,发给VM合同 xchain.attestation.request(...) 有提供者 id 'llm'· ; AttestationHelpers.httpGet({url}) 验证 URL并返回有效载荷字符串 'http_get'· ; AttestationHelpers.requestOptions({redundancy, deadlineBlocks}) 构建网关选项对象。 根据设计,这些只是信封构建器:没有用户可推荐的ATTEST动作. ATTEST v0(请求)和v1(答复)为VM-发送:合同呼叫 xchain.attestation.request(...) 并释放出链上的证据。 因此,SDK帮助你塑造一个合同提出的要求,你通过 getAttestations()它没有(而且不能)直接编码ATTEST行动,同样,XCALL只编码VM-排放.
• 拥有权交易助手数字 : ORDER编号 :SWAP编号 :DISPENSER v0 载 GIVE_OWNERSHIP 编号 : GET_OWNERSHIP 旗帜; SWEEP 独立携带 ORDERS 编号 : SWAPS 编号 : DISPENSERS 旗帜( 是单一的) ESCROWS 旗帜)
• HTTP 402次付款数字 : X402Client 财务报告和审定财务报表 X402Gateway 实施XChain-native, x402- 形状的按呼计酬流程,在链式SEND行动之上进行 xchain-send (按要求付费), xchain-dispenser (持有进入权),和 xchain-deposit (计算支出分类账)计划;客户只支付每笔勾 maxAmount 最高的,每一次都拒绝。 见 x402 付款额
• 以合同为目标的抽取数字 : session.stakeToContract({ amount, signingPubkey, targetContractIndex, tick }), (中文(简体) ), session.unstakeFromContract({...}),以及 session.delegateForContract({...}) 将STAKE v3 / UNSTAKE v1 / DELEGATE v1 与通过DEBOY v1(与 COOLDOWN_BLOCKS + 键 SLASH_DESTINATION) (中文(简体) ). 高级别食谱: sdk.deployStakeableContract() 财务报告和审定财务报表 sdk.stakeToContractAndDelegate()
• NFT 帮助者数字 : sdk.nft.unique(), (中文(简体) ), sdk.nft.edition(), (中文(简体) ), sdk.nft.collectionItem(), (中文(简体) ), sdk.nft.attachContentParams(),以及 sdk.nft.isNft() 用于构建 NFT 模式(ISSUE 有 DECIMALS=0 + LOCK MAX SUPPLY=1) 外加高级 sdk.issueNft(), (中文(简体) ), sdk.issueNftEdition(), (中文(简体) ), sdk.issueCollectionItem(),以及 sdk.attachContent() 提交食谱
• 项目登记册助手数字 : sdk.project.rosterParams() 财务报告和审定财务报表 sdk.project.rosterEditParams() 为所有者测试的代号名册建立列表动作; sdk.setRoster() 运行列表然后 LINK 并等待索引器
• 车票压缩: 在默认情况下; 解决其紧凑的符号计数器 ^id 在编码缩小链上有效载荷大小之前,通过探险器形成电线; 选择退出 { compactTickers: false }
• MCP 服务器数字 : npx xchain-mcp 将所有探索者查询工具曝光为 模型背景协议工具,供 AI 代理使用
• 钱包认证( A):关键管理,PSBT签名,质疑-回应核查
• 智能合同:通过xchain-vm集成部署、执行、交存、退出
• 飞行前合同身份: 已部署的合同必须出口 meta: { name, description, version } (单位:千美元)CONTRACT_META_REQUIRED) (中文(简体) ). sdk.deploy(), (中文(简体) ), session.deploy(), (中文(简体) ), session.deployChunk(), (中文(简体) ), sdk.deployAndFund() 财务报告和审定财务报表 sdk.deployStakeableContract() 在动作组成前静地读取,并用链条本身的判决字符串拒绝,因此索引者会拒绝一份合同,永远不收费. sdk.contracts.getExportedMeta(source) 显示相同的读取
• 枢纽发现: xchain-hub 的自动解析服务端点
• 用后退重试:处理HTTP 429/502/503/504,尊重 Retry-After 页眉
• 请求钩子数字 : onRequest, (中文(简体) ), onResponse, (中文(简体) ), onError, (中文(简体) ), onRetry 调用
• 类型脚本定义: 满 .d.ts 用于 IDE 自动完成
• 浏览器捆绑: 用于客户端的浏览构建

文档

完整的 SDK 开发者指南发布于 文件.xchain.io/组件/sdk数字 :

安装

npm install @dankest-llc/xchain-sdk

节点22或更新. 为了针对源进行开发,克隆此寄存器和 npm install 内部; 辅助的 AI 代理的 MCP 服务器单独发布为 xchain-mcp。 。 。 .

快速启动

const { XChainSDK } = require('@dankest-llc/xchain-sdk');

// Zero-config: a network alone targets the public XChain Platform.
// Mainnet/testnet default to the public hosts (hub.xchain.io discovers
// explorer/encoder, falling back to explorer.xchain.io / encoder.xchain.io);
// on any *-regtest network only the explorer defaults to localhost:8080. The
// encoder (needed for writes) needs ENCODER_URL or ENCODER_PORT, and the
// WebSocket needs a WEBSOCKET_* or EXPLORER_* URL or port (or the matching
// constructor options).
const sdk = new XChainSDK({ network: 'bitcoin-mainnet' });

// To point at your own services, pass full URLs (include the scheme; a
// bare host is treated as http://host:<dev-port>):
// const sdk = new XChainSDK({
//     network: 'bitcoin-mainnet',
//     explorerUrl: 'https://explorer.example.com',
//     encoderUrl:  'https://encoder.example.com'
// });

// Generate an action string
const result = await sdk.send({
    tick: 'MYTOKEN',
    amount: '100',
    destination: 'bc1q...',
    memo: 'Payment'
});
console.log(result.actionString); // 'SEND|0|MYTOKEN|100|bc1q...|Payment'

// Multi-destination SEND: one entry per recipient. The wire format version
// is chosen from the legs (v1 shared tick, v2 per-leg tick, v3 per-leg memo).
// A flat {tick, amount, destination} map can only ever express ONE leg, so
// the SDK refuses one against a multi-leg format instead of repeating leg 1.
const multi = await sdk.send({
    tick: 'MYTOKEN',
    legs: [
        { amount: '100', destination: 'bc1qaddr1...' },
        { amount: '250', destination: 'bc1qaddr2...' }
    ]
});
console.log(multi.actionString); // 'SEND|1|MYTOKEN|100|bc1qaddr1...|250|bc1qaddr2...'

// Full lifecycle: create, encode, sign, broadcast, wait for indexer
const tx = await sdk.submitAction(
    { action: 'SEND', params: { tick: 'MYTOKEN', amount: '100', destination: 'bc1q...' } },
    { pubkey: '02abc123...' },
    { wif: 'your-wif-key' }
);
console.log(tx.txid);    // transaction hash
console.log(tx.indexed); // action data from the indexer

// Wallet session: bind to a key and send multiple actions
const session = sdk.session('your-wif-key');
await session.send({ tick: 'MYTOKEN', amount: '50', destination: 'bc1q...' });
await session.send({ tick: 'MYTOKEN', amount: '50', destination: 'bc1q...' });
const balances = await session.getBalances();

// Workflow recipes: multi-step operations in one call
await sdk.issueAndDistribute('your-wif-key',
    { tick: 'NEWTOKEN', maxSupply: '1000000', decimals: 8 },
    [
        { destination: 'bc1qaddr1...', amount: '500000' },
        { destination: 'bc1qaddr2...', amount: '300000' }
    ]
);

// Deploy a smart contract. Every contract must export its identity: `meta.name`
// and `meta.description` are consensus-required (CONTRACT_META_REQUIRED), and
// `meta.version` is optional but indexed. Use STRING LITERALS: the chain evaluates
// `meta` at deploy, so a computed name is not what you read in the source, and the
// pre-flight cannot check it for you.
const code = `module.exports = {
    meta: {
        name:        'Escrow',                           // 1..64 bytes
        description: 'Two-party escrow with an arbiter', // 1..512 bytes
        version:     '1.0.0'                             // optional, 1..32 bytes
    },
    permissions: ['SEND'],
    initialize(xchain) { xchain.state.set('status', 'OPEN'); }
};`;
await session.deploy({ code, gasLimit: 200000 });

// A contract with no conforming meta is refused BEFORE anything is composed,
// signed or broadcast, with the exact verdict the indexer would have written:
//   SDKContractError: invalid: CONTRACT_MANIFEST (meta required)
// Pass { preflight: 'warn' | 'off' } (session/workflow seams) or
// { lint: 'warn' | 'off' } (sdk.deploy) to downgrade or skip the check; the
// deploy is still rejected on-chain. A computed or unreadable `meta` only warns.
sdk.contracts.getExportedMeta(code);  // { status: 'present', name: 'Escrow', ... }

// Query blockchain data. The token record arrives NESTED under `info`:
const token = await sdk.getToken('MYTOKEN');
token.info.tick_id;   // '42'   <- the fields live here
token.tick_id;        // undefined

// A tick that does not exist answers HTTP 404, so getToken() THROWS
// SDKExplorerError (code EXPLORER_HTTP_404) instead of answering an empty
// body. Use these for an existence check rather than a try/catch:
await sdk.tokenExists('MYTOKEN');   // true / false, never throws on absence
await sdk.findToken('MYTOKEN');     // the unwrapped info record, or null

// Both answer "absent" only for the 404. A timeout, network failure, 429 or
// 5xx still throws, because an explorer that could not answer is not proof
// that the ticker is free.

配置

脚本

API 服务器模块

npm run api (单位:千美元)node ./src/api/index.js)运行 JSON-RPC 服务器作为一个独立进程,打开一个收听器 SDK_API_PORT 满载。 消费者想要拥有服务器,将服务器安装在现有快件下,选择自己的收听路径,或者从测试开始并阻止它,则需要模块直接而不是轰出脚本:

const { createApp, startApi } = require('@dankest-llc/xchain-sdk/src/api');

// createApp(sdk) is synchronous and listener-free: it wires the same guard
// stack (rate limit, auth gate, batch cap, /openrpc.json, JSON-RPC router)
// as the CLI entry and returns the express app to mount yourself.
const app = createApp(sdk);

// startApi({ port }) builds the SDK from the environment, runs hub discovery,
// and resolves to the listening http.Server (port 0 for an ephemeral port).
const server = await startApi({ port: 0 });
await new Promise((resolve) => server.close(resolve));

请求 src/api 永不打开套接字;只打开 CLI 条目(npm run api 编号 : node ./src/api/index.js)开始自动收听.

测试套件

版权:2025-2026 Dankest, LLC

依据创用CC授权使用 页:1

凭 GNU 阿费罗通用公共许可证 v3.0 (AGPL-3.0-或-后期) 拥有可供专有使用的商业许可证.

您可以根据许可证的规定使用、修改和分发这些材料. 见 自由主义 财务报告和审定财务报表 通知 满期. 见 许可概览。 。 。 .