@defichain/jellyfish-api-core

中文文档
4.0.7发布于 2024/02/23MITTypeScriptCommonJS近 30 天下载 6396

SDK & Security 用于在规模上构建现代 lite DeFi 应用程序.

中文使用文档
文档目录4 节
  1. 特征
  2. 用法示例
  3. 发展
  4. 测试

@defichain/ jellyfish- api- core (英语)

@defichain/jellyfish-api-core 是一个不可知的 DeFiChain 客户端执行协议,将 API 分离为它们的 类别.

特征

  • Promise<T> 首次执行 防止召回地狱.
  • 数字精确感知 JSON 用选项解析 lossless, (中文(简体) ), bignumber 或者说 number。 。 。 .
  • 在 TypeScript 中执行,有强烈的输入界面,导出为 *.d.ts 我也一样.
  • 可用 RPC 原始呼叫 client.call('getbalance', [], 'bignumber')

用法示例

const result = await client.mining.getMiningInfo()
// or
client.mining.getMiningInfo().then((result) => {
  console.log(result)
}).catch((err) => {
  console.log('panic!')
}).finally(() => {
  console.log('cleanup')
})

发展

ApiClient 作为抽象类允许在引入时适应任何协议的能力(例如 ws, https) 简单易用 这种执行结构可以在集装箱雷达站中观测到 测试水母-api-core执行.

危险品分类分为 jellyfish-api-core/src/category/*.ts (例如:. category/mining.ts这允许 议定书不可预见地执行《议定书》。 所有关切都归入一个类别 ts 用于更好的开发者的文件 浏览和维护代码的经验.

ApiError 在一个结构内封装来自 DeFiChain 的 RPC 错误。 这允许 instanceof 或错误类型 处理结构丰富.

JellyfishJSON 允许用“ 无损失” 、 “ 大数字” 和“ 数字” 精确度来解析 JSON .

  • "无所失" 使用 LosslessJSON 将数值分析为 Lossless Number 。 以无损失数量,一个人可以表演 常规数字操作,当会导致信息丢失时,它就会出错.
  • "大数字" 使用 bignumber.js 库将所有数值解析为“ 大数字”.
  • "数字" 将所有数值分析为“ 数字” , 如果超过 IEEE-754 标准, 精度将变为损失 .
  • "精密的纸张" 提供基于路径的精确映射, 指定“ big number ” 将自动映射全部数字 这条路作为"大数字"。 否则,它将默认为数字,这非常适用.

测试

jest

随着《区域规划》的实施 jellyfish-api-core,所有关于《公约》执行情况的测试都应进行 打开 jellyfish-api-core。 。 。 . ContainerAdapterClient 通过适配器执行来方便测试 所有RPC 代理为 a @defichain/testcontainers。 。 。 .

版本与发布记录

@defichain/jellyfish-api-core 共发布 294 个版本,首次发布于 2021/03/30;过去 12 个月发布了 0 个版本。

版本发布日期距今
4.0.7latest2024/02/232 年前
4.0.62024/02/052 年前
4.0.52023/12/052 年前
4.0.12023/11/142 年前
4.0.02023/11/033 年前
4.0.0-beta.14.12023/10/133 年前

其他发布通道:next → 0.32.0。

关于 @defichain/jellyfish-api-core 的常见问题

@defichain/jellyfish-api-core 是什么?

SDK & Security 用于在规模上构建现代 lite DeFi 应用程序.

如何安装 @defichain/jellyfish-api-core?

在项目目录运行 npm install @defichain/jellyfish-api-core,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:defichain(^4.0.7)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@defichain/jellyfish-api-core 支持 TypeScript 吗?

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

@defichain/jellyfish-api-core 支持 ESM 还是 CommonJS?

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

@defichain/jellyfish-api-core 可以商用吗?

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

@defichain/jellyfish-api-core 的下载量有多少?

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

@defichain/jellyfish-api-core 还在维护吗?

最新版本 4.0.7 发布于 2024/02/23(2 年前);至今共发布 294 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/03/30。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。