chore: migrate defined -> codex

bradens · bradens · commit 0d2d9f87dc8c · 2024-08-27T14:03:03.000-07:00
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -20,4 +20,4 @@ jobs:
       - run: bun run build
       - run: npm publish --access public
         env:
-          NPM_TOKEN: ${{secrets.DEFINED_SDK_NPM_TOKEN}}
+          NPM_TOKEN: ${{secrets.CODEX_SDK_NPM_TOKEN}}
diff --git a/README.md b/README.md
@@ -6,16 +6,16 @@ It provides the public schema SDL for you to use. You can use graphql-codegen to
 
 > [!NOTE]
 > We've changed our name from Defined to Codex.
-> 
+>
 > You will see references to our previous company name, Defined, while we make the switch to Codex.
 
 ## Installation
 
 | packager                      | command                   |
 | ----------------------------- | ------------------------- |
-| [npm](https://www.npmjs.com/) | `npm add @definedfi/sdk`  |
-| [yarn](https://yarnpkg.com/)  | `yarn add @definedfi/sdk` |
-| [bun](https://bun.sh/)        | `bun add @definedfi/sdk`  |
+| [npm](https://www.npmjs.com/) | `npm add @codex-data/sdk`  |
+| [yarn](https://yarnpkg.com/)  | `yarn add @codex-data/sdk` |
+| [bun](https://bun.sh/)        | `bun add @codex-data/sdk`  |
 
 ## Usage
 
@@ -24,9 +24,9 @@ Follow one of the examples in the [examples](/examples) directory, or simply run
 Fetch a token.
 
 ```typescript
-import { Defined } from "@definedfi/sdk";
+import { Codex } from "@codex-data/sdk";
 
-const sdk = new Defined(MY_API_KEY);
+const sdk = new Codex(MY_API_KEY);
 
 sdk.queries
   .token({
@@ -42,9 +42,9 @@ Use your own GraphQL selections
 
 ```typescript
 import { Network } from "../../src/resources/graphql";
-import { Defined } from "@definedfi/sdk/dist/sdk";
+import { Codex } from "@codex-data/sdk/dist/sdk";
 
-const sdk = new Defined(process.env.DEFINED_API_KEY || "");
+const sdk = new Codex(process.env.CODEX_API_KEY || "");
 
 sdk
   .send<{ getNetworks: Network[] }>(
@@ -62,7 +62,7 @@ sdk
 
 ## Running the examples
 
-You'll need to have [`curl`](https://curl.se/) installed in order to build this locally, as it fetches the schema from the Defined API.
+You'll need to have [`curl`](https://curl.se/) installed in order to build this locally, as it fetches the schema from the Codex API.
 
 You need to provide an API key in order for the examples to work. We have [bun](https://bun.sh) in use for development here.
 
@@ -77,7 +77,7 @@ This performs a simple inline graphql request, and uses a user-provided query an
 
 - `cd examples/simple`
 - `bun i`
-- `DEFINED_API_KEY=xyz bun run index.ts`
+- `CODEX_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.
@@ -89,15 +89,15 @@ This shows how to use graphql-codegen to generate query types and get a fully ty
 - `cd examples/codegen`
 - `bun i`
 - `bun run codegen`
-- `DEFINED_API_KEY=xyz bun run src/index.ts`
+- `CODEX_API_KEY=xyz bun run src/index.ts`
 
 ### Next
 
 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`
+- `NEXT_PUBLIC_CODEX_API_KEY=xyz bun run dev`
 
 ## Contributing
 
diff --git a/examples/codegen/codegen.ts b/examples/codegen/codegen.ts
@@ -1,15 +1,15 @@
-import type { CodegenConfig } from '@graphql-codegen/cli';
+import type { CodegenConfig } from "@graphql-codegen/cli";
 
 const config: CodegenConfig = {
   overwrite: true,
-  schema: "node_modules/@definedfi/sdk/src/resources/schema.graphql",
+  schema: "node_modules/@codex-data/sdk/src/resources/schema.graphql",
   documents: "src/**/*.ts",
   generates: {
     "src/gql/": {
       preset: "client",
-      plugins: ["typescript-document-nodes"]
-    }
-  }
+      plugins: ["typescript-document-nodes"],
+    },
+  },
 };
 
 export default config;
diff --git a/examples/codegen/package.json b/examples/codegen/package.json
@@ -10,7 +10,7 @@
   "license": "ISC",
   "description": "",
   "dependencies": {
-    "@definedfi/sdk": "../../",
+    "@codex-data/sdk": "../../",
     "@graphql-codegen/typescript-document-nodes": "^4.0.1",
     "graphql": "^16.8.0",
     "typescript": "^5.2.2"
diff --git a/examples/codegen/src/index.ts b/examples/codegen/src/index.ts
@@ -1,6 +1,6 @@
-import { Defined } from '../../../src/sdk';
-import { graphql } from './gql/gql';
-import { NetworksQuery, NetworksQueryVariables } from './gql/graphql';
+import { Codex } from "../../../src/sdk";
+import { graphql } from "./gql/gql";
+import { NetworksQuery, NetworksQueryVariables } from "./gql/graphql";
 
 const doc = graphql(`
   query Networks {
@@ -11,10 +11,8 @@ const doc = graphql(`
   }
 `);
 
-const sdk = new Defined(process.env.DEFINED_API_KEY || "");
-
-sdk.query<NetworksQuery, NetworksQueryVariables>(doc).then(res => {
-  console.log("Fetched res", res)
-})
-
+const sdk = new Codex(process.env.CODEX_API_KEY || "");
 
+sdk.query<NetworksQuery, NetworksQueryVariables>(doc).then((res) => {
+  console.log("Fetched res", res);
+});
diff --git a/examples/next/README.md b/examples/next/README.md
@@ -5,11 +5,11 @@ This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next
 First, run the development server:
 
 ```bash
-NEXT_PUBLIC_DEFINED_API_KEY=xyz npm run dev
+NEXT_PUBLIC_CODEX_API_KEY=xyz npm run dev
 # or
-NEXT_PUBLIC_DEFINED_API_KEY=xyz yarn run dev
+NEXT_PUBLIC_CODEX_API_KEY=xyz yarn run dev
 # or
-NEXT_PUBLIC_DEFINED_API_KEY=xyz pnpm dev
+NEXT_PUBLIC_CODEX_API_KEY=xyz pnpm dev
 ```
 
 Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
diff --git a/examples/next/package.json b/examples/next/package.json
@@ -16,6 +16,6 @@
     "react": "18.2.0",
     "react-dom": "18.2.0",
     "typescript": "5.2.2",
-    "@definedfi/sdk": "../../"
+    "@codex-data/sdk": "../../"
   }
 }
diff --git a/examples/next/src/app/GetNetworks.tsx b/examples/next/src/app/GetNetworks.tsx
@@ -1,8 +1,8 @@
-import { Defined } from "@definedfi/sdk/dist/sdk";
-import { Network } from "@definedfi/sdk/src/resources/graphql";
+import { Codex } from "@codex-data/sdk/dist/sdk";
+import { Network } from "@codex-data/sdk/src/resources/graphql";
 
 async function getData() {
-  const sdk = new Defined(process.env.NEXT_PUBLIC_DEFINED_API_KEY || "");
+  const sdk = new Codex(process.env.NEXT_PUBLIC_CODEX_API_KEY || "");
   const res = await sdk.send<{ getNetworks: Network[] }>(
     `query { getNetworks { id, name } }`,
   );
diff --git a/examples/simple/bun.lockb b/examples/simple/bun.lockb
diff --git a/examples/simple/filterTest.ts b/examples/simple/filterTest.ts
@@ -1,6 +1,6 @@
-import { Defined } from '@definedfi/sdk'
+import { Codex } from '@codex-data/sdk'
 
-const sdk = new Defined(process.env.DEFINED_API_KEY || "")
+const sdk = new Codex(process.env.CODEX_API_KEY || "")
 
 sdk.queries.filterTokens({
   filters: {
diff --git a/examples/simple/index.ts b/examples/simple/index.ts
@@ -1,9 +1,9 @@
-import { Defined } from "@definedfi/sdk";
+import { Codex } from "@codex-data/sdk";
 
 // import { AlertRecurrence } from "../../dist/sdk/generated/graphql";
 import { AlertRecurrence, Network } from "../../src/resources/graphql";
 
-const sdk = new Defined(process.env.DEFINED_API_KEY || "");
+const sdk = new Codex(process.env.CODEX_API_KEY || "");
 
 sdk
   .send<{ getNetworks: Network[] }>(
diff --git a/examples/simple/package.json b/examples/simple/package.json
@@ -7,6 +7,6 @@
   "license": "ISC",
   "description": "",
   "dependencies": {
-    "@definedfi/sdk": "^0.5.3"
+    "@codex-data/sdk": "^0.5.7"
   }
 }
diff --git a/examples/simple/realtime.ts b/examples/simple/realtime.ts
@@ -1,8 +1,8 @@
-import { Defined } from '@definedfi/sdk/dist/sdk'
+import { Codex } from '@codex-data/sdk/dist/sdk'
 import { Price, SubscriptionOnPriceUpdatedArgs } from '../../src/resources/graphql'
 import { ExecutionResult, Sink } from 'graphql-ws'
 
-const sdk = new Defined(process.env.DEFINED_API_KEY || "")
+const sdk = new Codex(process.env.CODEX_API_KEY || "")
 
 const sink: Sink<ExecutionResult<Price>> = {
   next: ({ data }) => {
diff --git a/examples/simple/simpleSubscription.ts b/examples/simple/simpleSubscription.ts
@@ -1,6 +1,6 @@
-import { Defined } from "@definedfi/sdk/dist/sdk";
+import { Codex } from "@codex-data/sdk/dist/sdk";
 
-const sdk = new Defined(process.env.DEFINED_API_KEY || "");
+const sdk = new Codex(process.env.CODEX_API_KEY || "");
 
 sdk.subscriptions.tokenPrices(
   {
diff --git a/examples/simple/tokens.ts b/examples/simple/tokens.ts
@@ -1,6 +1,6 @@
-import { Defined } from "@definedfi/sdk";
+import { Codex } from "@codex-data/sdk";
 
-const sdk = new Defined(process.env.DEFINED_API_KEY || "");
+const sdk = new Codex(process.env.CODEX_API_KEY || "");
 
 sdk.queries
   .token({
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@definedfi/sdk",
+  "name": "@codex-data/sdk",
   "version": "0.5.7",
   "engines": {
     "node": ">=17.5.0"
@@ -8,7 +8,7 @@
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "bun run fetch:schema && bun run codegen && bun run tsc",
-    "fetch:schema": "curl -s https://graph.defined.fi/schema/latest.graphql --output src/resources/schema.graphql",
+    "fetch:schema": "curl -s https://graph.codex.io/schema/latest.graphql --output src/resources/schema.graphql",
     "codegen": "graphql-codegen --config codegen.ts",
     "prepack": "cp src/resources/* dist/resources/",
     "lint": "eslint --ext .ts src",
@@ -26,11 +26,11 @@
     "blockchain",
     "api"
   ],
-  "repository": "github:definedfi/sdk",
-  "author": "Defined.fi",
+  "repository": "github:codex-data/sdk",
+  "author": "Codex",
   "license": "MIT",
-  "homepage": "https://docs.defined.fi",
-  "description": "The Defined.fi SDK for JavaScript/Typescript. It provides generated types and convenient ways to access the graphql api.",
+  "homepage": "https://docs.codex.io",
+  "description": "The Codex SDK for JavaScript/Typescript. It provides generated types and convenient ways to access the graphql api.",
   "dependencies": {
     "@types/jest": "^29.5.4",
     "@types/node": "^20.5.7",
diff --git a/src/sdk/Mutation.ts b/src/sdk/Mutation.ts
@@ -4,10 +4,10 @@ import {
   CreateWebhooksInput,
   DeleteWebhooksDocument,
 } from "./generated/graphql";
-import { Defined } from "./index";
+import { Codex } from "./index";
 
 export class Mutation {
-  constructor(private sdk: Defined) {}
+  constructor(private sdk: Codex) {}
   createWebhooks = async (vars: { input: CreateWebhooksInput }) =>
     this.sdk.mutation(CreateWebhooksDocument, vars);
   deleteWebhooks = async (vars: { input: DeleteWebhooksInput }) =>
diff --git a/src/sdk/Query.test.ts b/src/sdk/Query.test.ts
@@ -1,8 +1,8 @@
 import { Event } from "../resources/graphql";
-import { Defined } from "./index";
+import { Codex } from "./index";
 
 describe("Query", () => {
-  const sdk = new Defined("dummy-key");
+  const sdk = new Codex("dummy-key");
 
   it("should set up queries", async () => {
     jest.spyOn(sdk, "query").mockResolvedValue({
diff --git a/src/sdk/Query.ts b/src/sdk/Query.ts
@@ -29,10 +29,10 @@ import {
   QueryListTopTokensArgs,
   QueryTokenArgs,
 } from "./generated/graphql";
-import { Defined } from "./index";
+import { Codex } from "./index";
 
 export class Query {
-  constructor(private sdk: Defined) {}
+  constructor(private sdk: Codex) {}
   pairEvents = async (vars: PairEventsQueryVariables) =>
     this.sdk.query(PairEventsDocument, vars);
   sparklines = async (vars: GetSparklinesQueryVariables) =>
diff --git a/src/sdk/Subscribe.ts b/src/sdk/Subscribe.ts
@@ -26,10 +26,10 @@ import {
   SubscriptionOnPairMetadataUpdatedArgs,
   SubscriptionOnPriceUpdatedArgs,
 } from "./generated/graphql";
-import { Defined } from "./index";
+import { Codex } from "./index";
 
 export class Subscribe {
-  constructor(private sdk: Defined) {}
+  constructor(private sdk: Codex) {}
   tokenPrices = async (
     vars: SubscriptionOnPriceUpdatedArgs,
     sink: Sink<ExecutionResult<OnPriceUpdatedSubscription>>,
diff --git a/src/sdk/index.test.ts b/src/sdk/index.test.ts
@@ -1,6 +1,6 @@
 import { DocumentNode } from "graphql";
 
-import { Defined } from "./index";
+import { Codex } from "./index";
 
 const getNetworksDocument = {
   kind: "Document",
@@ -32,10 +32,10 @@ const getNetworksDocument = {
 const getNetworksString = `query GetNetworks { getNetworks { id } }`;
 const subscribePriceUpdatedString = `subscription onPriceUpdated($address: String!, $networkId: Int!) { onPriceUpdated(address: $address, networkId: $networkId) { address networkId priceUsd timestamp } }`;
 
-describe("Defined", () => {
-  let sdk: Defined;
+describe("Codex", () => {
+  let sdk: Codex;
   beforeEach(() => {
-    sdk = new Defined("dummy-key");
+    sdk = new Codex("dummy-key");
   });
 
   describe("query", () => {
diff --git a/src/sdk/index.ts b/src/sdk/index.ts
@@ -16,7 +16,7 @@ import { Subscribe } from "./Subscribe";
 
 export type CleanupFunction = () => void;
 
-export class Defined {
+export class Codex {
   private client: GraphQLClient;
   private wsClient: GraphQLWsClient;
   public queries: Query;
@@ -25,8 +25,8 @@ export class Defined {
 
   constructor(
     private apiKey: string,
-    private apiUrl: string = `https://graph.defined.fi/graphql`,
-    private apiRealtimeUrl: string = `wss://realtime-api.defined.fi/graphql`,
+    private apiUrl: string = `https://graph.codex.io/graphql`,
+    private apiRealtimeUrl: string = `wss://graph.codex.io/graphql`,
   ) {
     invariant(this.apiKey, "apiKey must be defined");
     this.queries = new Query(this);

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,6 @@`
`16`	`16`	`"react": "18.2.0",`
`17`	`17`	`"react-dom": "18.2.0",`
`18`	`18`	`"typescript": "5.2.2",`
`19`		`- "@definedfi/sdk": "../../"`
	`19`	`+ "@codex-data/sdk": "../../"`
`20`	`20`	`}`
`21`	`21`	`}`