styx
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseStyx Skill
Styx Skill
Trustless BTC→sBTC conversion via the Styx protocol by FaktoryFun. Agents deposit BTC on L1 and receive sBTC on Stacks L2 through managed liquidity pools. Uses .
@faktoryfun/styx-sdk通过FaktoryFun推出的Styx协议实现无需信任的BTC→sBTC转换。Agent在L1层存入BTC,即可通过托管流动性池在Stacks L2层获得sBTC。本工具使用开发。
@faktoryfun/styx-sdkHow It Works
工作流程
- Check pool liquidity — shows available sBTC in the pool
pool-status - Create deposit reservation — reserves pool liquidity and returns a deposit ID
deposit - Build & sign transaction — The SDK provides UTXOs and deposit address; the agent builds and signs locally with
@scure/btc-signer - Broadcast — Signed transaction is broadcast to mempool.space
- Track status — monitors the deposit through confirmation
status
- 查询资金池流动性 —— 命令可显示资金池中可用的sBTC数量
pool-status - 创建存款预留 —— 命令会锁定资金池流动性并返回存款ID
deposit - 构建并签名交易 —— SDK提供UTXO和存款地址;Agent通过在本地构建并签名交易
@scure/btc-signer - 广播交易 —— 已签名的交易将广播至mempool.space
- 追踪状态 —— 命令可监控存款直至确认完成
status
Pools
资金池信息
| Pool ID | Type | Min Deposit | Max Deposit | Swap Types |
|---|---|---|---|---|
| Legacy | 10,000 sats | 300,000 sats | sbtc, usda, pepe |
| AI BTC | 10,000 sats | 1,000,000 sats | sbtc, aibtc |
| 资金池ID | 类型 | 最低存款额 | 最高存款额 | 兑换类型 |
|---|---|---|---|---|
| 传统型 | 10,000聪 | 300,000聪 | sbtc, usda, pepe |
| AI BTC | 10,000聪 | 1,000,000聪 | sbtc, aibtc |
Subcommands
子命令
pool-status
pool-status
bun run styx/styx.ts pool-status [--pool main|aibtc]Returns , (BTC), and .
realAvailableestimatedAvailablelastUpdatedbun run styx/styx.ts pool-status [--pool main|aibtc]返回、(以BTC为单位)以及字段。
realAvailableestimatedAvailablelastUpdatedpools
pools
bun run styx/styx.ts poolsLists all available pools with configs and active status.
bun run styx/styx.ts pools列出所有可用资金池的配置及活跃状态。
fees
fees
bun run styx/styx.ts feesReturns current Bitcoin network fee estimates (low/medium/high in sat/vB).
bun run styx/styx.ts fees返回当前比特币网络的手续费估算值(低/中/高,单位:聪/字节)。
price
price
bun run styx/styx.ts priceReturns current BTC price in USD.
bun run styx/styx.ts price返回当前BTC的美元价格。
deposit
deposit
bun run styx/styx.ts deposit --amount <sats> --stx-receiver <addr> --btc-sender <addr> [--pool main|aibtc] [--fee low|medium|high]Full headless deposit flow: creates reservation, prepares PSBT, signs with wallet key, broadcasts to mempool.space, and updates deposit status. Requires an unlocked wallet.
bun run styx/styx.ts deposit --amount <sats> --stx-receiver <addr> --btc-sender <addr> [--pool main|aibtc] [--fee low|medium|high]完整的无头存款流程:创建预留、生成PSBT、使用钱包密钥签名、广播至mempool.space并更新存款状态。要求钱包处于解锁状态。
status
status
bun run styx/styx.ts status --id <deposit-id>
bun run styx/styx.ts status --txid <btc-txid>Check deposit status by deposit ID or Bitcoin transaction ID.
bun run styx/styx.ts status --id <deposit-id>
bun run styx/styx.ts status --txid <btc-txid>通过存款ID或比特币交易ID查询存款状态。
history
history
bun run styx/styx.ts history --address <stx-addr>Get deposit history for a Stacks address.
bun run styx/styx.ts history --address <stx-addr>获取指定Stacks地址的存款历史记录。
Deposit Statuses
存款状态
- — Deposit record created, liquidity reserved
initiated - — Bitcoin tx broadcast to mempool
broadcast - — At least 1 BTC confirmation
processing - — Required confirmations reached, sBTC minted
confirmed - — User requested refund
refund-requested - — Deposit canceled, liquidity released
canceled
- —— 已创建存款记录,流动性已锁定
initiated - —— 比特币交易已广播至内存池
broadcast - —— 至少获得1次BTC网络确认
processing - —— 达到所需确认次数,sBTC已铸造完成
confirmed - —— 用户已发起退款请求
refund-requested - —— 存款已取消,流动性已释放
canceled
Notes
注意事项
- Always check before depositing to verify sufficient liquidity
pool-status - Update deposit status after broadcast — this is critical for accurate pool accounting
- Min deposit: 10,000 sats (0.0001 BTC). Max varies by pool.
- The SDK uses a pre-configured API key for the Styx backend
- 存款前务必通过确认资金池有足够流动性
pool-status - 交易广播后请更新存款状态——这对资金池的准确核算至关重要
- 最低存款额:10,000聪(0.0001 BTC)。最高存款额因资金池而异。
- SDK使用预配置的API密钥对接Styx后端服务