# @definedfi/sdk 中文文档

规范地址：https://npmcn.com/package/%40definedfi/sdk/

版本：0\.5\.6
npm 元数据更新时间：2024-07-04T15:05:54.509Z
中文译文更新时间：2026-11-11T20:56:56.792Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40definedfi/sdk
原文对照：https://npmcn.com/package/%40definedfi/sdk/?lang=original
项目主页：https://docs.defined.fi/
源码仓库：https://github.com/definedfi/sdk

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：7.9 MB，97 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=17\.5\.0
- 运行依赖：7 个
- 首次发布：2023-08-29T18:23:44.762Z
- 最新版本发布：2024-07-04T15:05:54.326Z
- 近 30 天下载量：29785（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 0 个）

## 中文简介

用于 JavaScript/ Typescript 的已定义.fi SDK 。 它提供了生成的类型和方便的方法来访问图克l api.

## 安装

```sh
npm install @definedfi/sdk
```

也可以使用：`pnpm add @definedfi/sdk`、`yarn add @definedfi/sdk`、`bun add @definedfi/sdk`

## README

# 定义的 SDK

此软件包的存在是为了帮助您在定义的 API 上开发( S)[https://docs. definance.fi 互联网档案馆的存檔,存档日期2013-10-02](https://docs.defined.fi/)) (中文(简体) ).

它提供公众的SDL计划 让你使用。 可以使用图克l-codegen生成类型和查询等.

## 安装

| 包装器 | 命令 |
| --- | --- |
| [无](https://www.npmjs.com/) | `npm add @definedfi/sdk` |
| [线条](https://yarnpkg.com/) | `yarn add @definedfi/sdk` |
| [包头](https://bun.sh/) | `bun add @definedfi/sdk` |

## 使用量

遵循其中的一个实例 [实例](https://npmcn.com/examples) 目录,或只是运行.

取个道具来.

```typescript
import { Defined } from "@definedfi/sdk";

const sdk = new Defined(MY_API_KEY);

sdk.queries
  .token({
    input: {
      address: "0xbb4cdb9cbd36b01bd1cbaebf2de08d9173bc095c",
      networkId: 56,
    },
  })
  .then(console.log);
```

使用您的图形QL 选择

```typescript
import { Network } from "../../src/resources/graphql";
import { Defined } from "@definedfi/sdk/dist/sdk";

const sdk = new Defined(process.env.DEFINED_API_KEY || "");

sdk
  .send<{ getNetworks: Network[] }>(
    `
  query GetNetworks {
    getNetworks { id name }
  }
`,
    {}
  )
  .then((res) => {
    console.log("Networks: ", res.getNetworks);
  });
```

## 运行实例

你需要拥有 [`curl`](https://curl.se/) 安装以在本地建立此功能, 因为它从定义的 API 中获取此功能.

您需要提供一个 API 密钥, 以便实例生效 。 我们有 [包头](https://bun.sh/) 用于发展.

安装后 [包头](https://bun.sh/),来自项目根.

-   `bun i`
-   `bun run build`

### 简单

这执行一个简单的内置图ql请求,并使用用户提供的查询和选择集.

-   `cd examples/simple`
-   `bun i`
-   `DEFINED_API_KEY=xyz bun run index.ts`

您可以定义自己的GraphQL查询,并使用有代码的查询(见下一节)。 我们提供的预先定义的查询 示例不包括每个查询的所有字段.

### 代码

这表明如何使用图克l-codegen生成查询类型并获得完全打入的端到端体验.

-   `cd examples/codegen`
-   `bun i`
-   `bun run codegen`
-   `DEFINED_API_KEY=xyz bun run src/index.ts`

### 下一个

这显示您如何在下一个JS项目中使用它 .

-   `cd examples/next`
-   `bun i`
-   `NEXT_PUBLIC_DEFINED_API_KEY=xyz bun run dev`

## 捐款

打开!

## 常见问题

### @definedfi/sdk 是什么？

用于 JavaScript/ Typescript 的已定义\.fi SDK 。 它提供了生成的类型和方便的方法来访问图克l api\.

### 如何安装 @definedfi/sdk？

在项目目录运行 npm install @definedfi/sdk，或使用 pnpm add / yarn add / bun add。

### @definedfi/sdk 支持 TypeScript 吗？

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

### @definedfi/sdk 支持 ESM 还是 CommonJS？

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

### @definedfi/sdk 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=17\.5\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @definedfi/sdk 可以商用吗？

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

### @definedfi/sdk 的下载量有多少？

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

### @definedfi/sdk 还在维护吗？

最新版本 0\.5\.6 发布于 2024/07/04（2 年前）；至今共发布 14 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/08/30。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。