Warning
We've changed our name from Defined to Codex.
There is a new Codex repo, and this Defined repo is no longer maintained.
Please go to https://github.com/Codex-Data/sdk to access the SDK.
This package exists to help you develop on top of the Defined API (https://docs.defined.fi).
It provides the public schema SDL for you to use. You can use graphql-codegen to generate types and queries for example.
packager | command |
---|---|
npm | npm add @definedfi/sdk |
yarn | yarn add @definedfi/sdk |
bun | bun add @definedfi/sdk |
Follow one of the examples in the examples directory, or simply run.
Fetch a token.
import { Defined } from "@definedfi/sdk";
const sdk = new Defined(MY_API_KEY);
sdk.queries
.token({
input: {
address: "0xbb4cdb9cbd36b01bd1cbaebf2de08d9173bc095c",
networkId: 56,
},
})
.then(console.log);
Use your own GraphQL selections
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);
});
You'll need to have curl
installed in order to build this locally, as it fetches the schema from the Defined API.
You need to provide an API key in order for the examples to work. We have bun in use for development here.
After installing bun, from the project root.
bun i
bun run build
This performs a simple inline graphql request, and uses a user-provided query and selection set.
cd examples/simple
bun i
DEFINED_API_KEY=xyz bun run index.ts
You can define your own GraphQL queries and use those with codegen (see next section). The pre-defined queries we provide in the examples do not include all of the fields for every query.
This shows how to use graphql-codegen to generate query types and get a fully typed end-to-end experience.
cd examples/codegen
bun i
bun run codegen
DEFINED_API_KEY=xyz bun run src/index.ts
This shows how you could use it in a NextJS project.
cd examples/next
bun i
NEXT_PUBLIC_DEFINED_API_KEY=xyz bun run dev
Prs open!