@clockwork-xyz/sdk

中文文档
0.3.4发布于 2023/05/18MITTypeScriptCommonJS近 30 天下载 5799

时钟打字机 SDK

中文使用文档
文档目录3 节
  1. 开始
  2. 说明
  3. 使用量

时钟 SDK

时钟打字机 SDK

License

开始

关于快速启动的指南和深入的教程,见 时钟文件。 。 。 . 直跳到例子,走 这里。关于最新的 Rust API 文件,请参见 时钟 Rust SDK。 。 。 .

说明

  • Clockwork SDK正在积极开发,因此所有API都会被改变.
  • 此代码未经审计. 自己冒险使用.

使用量

首先,初始化a ClockworkProvider

const wallet = new NodeWallet(new Keypair());
const connection = new Connection(clusterApiUrl("devnet"));
const clockworkProvider = new ClockworkProvider(wallet, connection);

#or
const anchorProvider = new anchor.AnchorProvider(
        connection,
        wallet,
        anchor.AnchorProvider.defaultOptions()
);
const provider = new ClockworkProvider.fromAnchorProvider(provider);

获取线索地址

const [pubkey, bump] = provider.getThreadPDA(
      wallet.publicKey,
      "ThreadProgramTest"
);

初始化线索

const ix = await provider.threadCreate(
      wallet.publicKey,         // authority
      "ThreadProgramTest",      // id
      [],                       // instructions to execute
      { now: {} },              // thread trigger
      0.1 * LAMPORTS_PER_SOL    // amount to send to the thread
);
const tx = new Transaction().add(ix);
const signature = await provider.anchorProvider.sendAndConfirm(tx);

获取串行数据去序列化

const threadAccount = await provider.getThreadAccount(threadPubkey);

暂停/恢复/重置/删除/线索

const ix = await provider.threadPause(wallet.publicKey, threadPubkey);
const ix = await provider.threadResume(wallet.publicKey, threadPubkey);
const ix = await provider.threadReset(wallet.publicKey, threadPubkey);
const ix = await provider.threadDelete(wallet.publicKey, threadPubkey);

更新线索

const ix = await provider.threadUpdate(wallet.publicKey, threadPubkey, {
      name: "TestUpdateThread",
      rateLimit: new BN(32),
      trigger: { now: {} },
});
const tx = new Transaction().add(ix);
const signature = await provider.anchorProvider.sendAndConfirm(tx);

退出线索

const ix = await provider.threadWithdraw(
      wallet.publicKey,
      threadPubkey,
      0.01 * LAMPORTS_PER_SOL
);
const tx = new Transaction().add(ix);
const signature = await provider.anchorProvider.sendAndConfirm(tx);

版本与发布记录

@clockwork-xyz/sdk 共发布 19 个版本,首次发布于 2022/12/11;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.3.4latest2023/05/183 年前
0.3.32023/05/133 年前
0.3.22023/05/123 年前
0.3.12023/05/053 年前
0.3.02023/03/243 年前
0.2.42023/03/223 年前

关于 @clockwork-xyz/sdk 的常见问题

@clockwork-xyz/sdk 是什么?

时钟打字机 SDK

如何安装 @clockwork-xyz/sdk?

在项目目录运行 npm install @clockwork-xyz/sdk,或使用 pnpm add / yarn add / bun add。

@clockwork-xyz/sdk 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@clockwork-xyz/sdk 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@clockwork-xyz/sdk 可以商用吗?

@clockwork-xyz/sdk 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@clockwork-xyz/sdk 的下载量有多少?

根据 npm 官方下载统计,@clockwork-xyz/sdk 在 2026/10/10 – 2026/11/08 这 30 天内被下载 5,799 次,日均约 193 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@clockwork-xyz/sdk 还在维护吗?

最新版本 0.3.4 发布于 2023/05/18(3 年前);至今共发布 19 个版本,其中过去 12 个月发布了 0 个;首次发布于 2022/12/11。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。