定义的 SDK

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

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

安装

使用量

遵循其中的一个实例 实例 目录,或只是运行.

取个道具来.

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

const sdk = new Defined(MY_API_KEY);

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

使用您的图形QL 选择

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 安装以在本地建立此功能, 因为它从定义的 API 中获取此功能.

您需要提供一个 API 密钥, 以便实例生效 。 我们有 包头 用于发展.

安装后 包头,来自项目根.

• 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

捐款

打开!