fix: Export our own types through the SDK (#402)

Co-authored-by: Satyajeet Kolhapure <[email protected]>
Consensys · Nov 22, 2023 · 7d3ee9b · 7d3ee9b
1 parent d570b00
commit 7d3ee9b
Show file tree

Hide file tree

Showing 27 changed files with 35 additions and 28 deletions.
diff --git a/explorer/src/App.tsx b/explorer/src/App.tsx
@@ -2,7 +2,7 @@ import { useState } from "react";
 import veraxLogo from "./assets/verax-logo-circle.svg";
 import "./App.css";
 import { ConnectKitButton } from "connectkit";
-import VeraxSdk from "@verax-attestation-registry/verax-sdk";
+import { VeraxSdk } from "@verax-attestation-registry/verax-sdk";
 
 function App() {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any

diff --git a/sdk/README.md b/sdk/README.md
@@ -32,7 +32,7 @@ var VeraxSdk = require("@verax-attestation-registry/verax-sdk");
 
 ```typescript
 // TypeScript
-import VeraxSdk from "@verax-attestation-registry/verax-sdk";
+import { VeraxSdk } from "@verax-attestation-registry/verax-sdk";
 ```
 
 ### 2. Instantiate VeraxSdk

diff --git a/sdk/examples/attestation/attestationExamples.ts b/sdk/examples/attestation/attestationExamples.ts
@@ -1,5 +1,5 @@
 import { Address } from "viem";
-import VeraxSdk from "../../src/VeraxSdk";
+import { VeraxSdk } from "../../src/VeraxSdk";
 
 export default class AttestationExamples {
   private veraxSdk: VeraxSdk;

diff --git a/sdk/examples/attestation/index.ts b/sdk/examples/attestation/index.ts
@@ -1,4 +1,4 @@
-import VeraxSdk from "../../src/VeraxSdk";
+import { VeraxSdk } from "../../src/VeraxSdk";
 import AttestationExamples from "./attestationExamples";
 
 let argv: string | null | undefined = process.argv[3] as string;

diff --git a/sdk/examples/module/index.ts b/sdk/examples/module/index.ts
@@ -1,4 +1,4 @@
-import VeraxSdk from "../../src/VeraxSdk";
+import { VeraxSdk } from "../../src/VeraxSdk";
 import ModuleExamples from "./moduleExamples";
 
 let argv: string | null | undefined = process.argv[3] as string;

diff --git a/sdk/examples/module/moduleExamples.ts b/sdk/examples/module/moduleExamples.ts
@@ -1,5 +1,5 @@
 import { Address } from "viem";
-import VeraxSdk from "../../src/VeraxSdk";
+import { VeraxSdk } from "../../src/VeraxSdk";
 
 export default class ModuleExamples {
   private veraxSdk: VeraxSdk;

diff --git a/sdk/examples/portal/index.ts b/sdk/examples/portal/index.ts
@@ -1,4 +1,4 @@
-import VeraxSdk from "../../src/VeraxSdk";
+import { VeraxSdk } from "../../src/VeraxSdk";
 import PortalExamples from "./portalExamples";
 
 let argv: string | null | undefined = process.argv[3] as string;

diff --git a/sdk/examples/portal/portalExamples.ts b/sdk/examples/portal/portalExamples.ts
@@ -1,5 +1,5 @@
 import { Address } from "viem";
-import VeraxSdk from "../../src/VeraxSdk";
+import { VeraxSdk } from "../../src/VeraxSdk";
 
 export default class PortalExamples {
   private veraxSdk: VeraxSdk;

diff --git a/sdk/examples/schema/index.ts b/sdk/examples/schema/index.ts
@@ -1,4 +1,4 @@
-import VeraxSdk from "../../src/VeraxSdk";
+import { VeraxSdk } from "../../src/VeraxSdk";
 import PortalExamples from "./schemaExamples";
 
 let argv: string | null | undefined = process.argv[3] as string;

diff --git a/sdk/examples/schema/schemaExamples.ts b/sdk/examples/schema/schemaExamples.ts
@@ -1,5 +1,5 @@
 import { Address } from "viem";
-import VeraxSdk from "../../src/VeraxSdk";
+import { VeraxSdk } from "../../src/VeraxSdk";
 
 export default class SchemaExamples {
   private veraxSdk: VeraxSdk;

diff --git a/sdk/examples/utils/decode.ts b/sdk/examples/utils/decode.ts
@@ -1,4 +1,4 @@
-import VeraxSdk from "../../src/VeraxSdk";
+import { VeraxSdk } from "../../src/VeraxSdk";
 
 const veraxSdk = new VeraxSdk(VeraxSdk.DEFAULT_LINEA_TESTNET);
 

diff --git a/sdk/examples/utils/encode.ts b/sdk/examples/utils/encode.ts
@@ -1,4 +1,4 @@
-import VeraxSdk from "../../src/VeraxSdk";
+import { VeraxSdk } from "../../src/VeraxSdk";
 
 const veraxSdk = new VeraxSdk(VeraxSdk.DEFAULT_LINEA_TESTNET);
 

diff --git a/sdk/examples/utils/getAttestationIdCounter.ts b/sdk/examples/utils/getAttestationIdCounter.ts
@@ -1,4 +1,4 @@
-import VeraxSdk from "../../src/VeraxSdk";
+import { VeraxSdk } from "../../src/VeraxSdk";
 
 const veraxSdk = new VeraxSdk(VeraxSdk.DEFAULT_LINEA_TESTNET);
 

diff --git a/sdk/examples/utils/getModulesNumber.ts b/sdk/examples/utils/getModulesNumber.ts
@@ -1,4 +1,4 @@
-import VeraxSdk from "../../src/VeraxSdk";
+import { VeraxSdk } from "../../src/VeraxSdk";
 
 const veraxSdk = new VeraxSdk(VeraxSdk.DEFAULT_LINEA_TESTNET);
 

diff --git a/sdk/examples/utils/getPortalsCount.ts b/sdk/examples/utils/getPortalsCount.ts
@@ -1,4 +1,4 @@
-import VeraxSdk from "../../src/VeraxSdk";
+import { VeraxSdk } from "../../src/VeraxSdk";
 
 const veraxSdk = new VeraxSdk(VeraxSdk.DEFAULT_LINEA_TESTNET);
 

diff --git a/sdk/examples/utils/getRelatedAttestation.ts b/sdk/examples/utils/getRelatedAttestation.ts
@@ -1,4 +1,4 @@
-import VeraxSdk from "../../src/VeraxSdk";
+import { VeraxSdk } from "../../src/VeraxSdk";
 
 const veraxSdk = new VeraxSdk(VeraxSdk.DEFAULT_LINEA_TESTNET);
 

diff --git a/sdk/examples/utils/getSchemasNumber.ts b/sdk/examples/utils/getSchemasNumber.ts
@@ -1,4 +1,4 @@
-import VeraxSdk from "../../src/VeraxSdk";
+import { VeraxSdk } from "../../src/VeraxSdk";
 
 const veraxSdk = new VeraxSdk(VeraxSdk.DEFAULT_LINEA_TESTNET);
 

diff --git a/sdk/examples/utils/getVersionNumber.ts b/sdk/examples/utils/getVersionNumber.ts
@@ -1,4 +1,4 @@
-import VeraxSdk from "../../src/VeraxSdk";
+import { VeraxSdk } from "../../src/VeraxSdk";
 
 const veraxSdk = new VeraxSdk(VeraxSdk.DEFAULT_LINEA_TESTNET);
 

diff --git a/sdk/package.json b/sdk/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@verax-attestation-registry/verax-sdk",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "description": "Verax Attestation Registry SDK to interact with the subgraph and the contracts",
   "keywords": [
     "linea-attestation-registry",
@@ -23,7 +23,7 @@
   "scripts": {
     "attestation": "ts-node examples/attestation/index.ts",
     "clean": "rm -rf ./lib",
-    "build": "pnpm run clean && tsc",
+    "build": "pnpm run clean && tsc --p ./tsconfig.build.json",
     "prepack": "npm run build",
     "publish:public": "pnpm publish --access public --no-git-checks",
     "module": "ts-node examples/module/index.ts",

diff --git a/sdk/src/VeraxSdk.ts b/sdk/src/VeraxSdk.ts
@@ -9,6 +9,8 @@ import { PrivateKeyAccount, privateKeyToAccount } from "viem/accounts";
 import { Conf } from "./types";
 import { SDKMode } from "./utils/constants";
 
+export * from "./types";
+
 let account: PrivateKeyAccount | Address;
 
 if (typeof window === "undefined") {
@@ -23,7 +25,7 @@ if (typeof window === "undefined") {
   });
 }
 
-export default class VeraxSdk {
+export class VeraxSdk {
   static DEFAULT_LINEA_MAINNET: Conf = {
     chain: linea,
     mode: SDKMode.BACKEND,

diff --git a/sdk/src/dataMapper/BaseDataMapper.ts b/sdk/src/dataMapper/BaseDataMapper.ts
@@ -1,7 +1,7 @@
 import { PublicClient, WalletClient } from "viem";
 import { Conf } from "../types";
 import { OrderDirection } from "../../.graphclient";
-import VeraxSdk from "../VeraxSdk";
+import { VeraxSdk } from "../VeraxSdk";
 import { stringifyWhereClause } from "../utils/graphClientHelper";
 import axios from "axios";
 

diff --git a/sdk/src/types/index.d.ts → sdk/src/types/index.ts b/sdk/src/types/index.d.ts → sdk/src/types/index.ts
@@ -1,4 +1,5 @@
-import { Address, Chain, EthereumProvider } from "viem";
+import { Address, Chain, EIP1193Provider } from "viem";
+import { SDKMode } from "../utils/constants";
 
 export interface Conf {
   chain: Chain;
@@ -71,6 +72,6 @@ export type OnChainModule = {
 
 declare global {
   interface Window {
-    ethereum: EthereumProvider;
+    ethereum: EIP1193Provider;
   }
 }
diff --git a/sdk/test/integration/Attestation.integration.test.ts b/sdk/test/integration/Attestation.integration.test.ts
@@ -1,4 +1,4 @@
-import VeraxSdk from "../../src/VeraxSdk";
+import { VeraxSdk } from "../../src/VeraxSdk";
 
 describe("AttestationDataMapper", () => {
   let veraxSdk: VeraxSdk;

diff --git a/sdk/test/integration/Module.integration.test.ts b/sdk/test/integration/Module.integration.test.ts
@@ -1,4 +1,4 @@
-import VeraxSdk from "../../src/VeraxSdk";
+import { VeraxSdk } from "../../src/VeraxSdk";
 
 describe("ModuleDataMapper", () => {
   let veraxSdk: VeraxSdk;

diff --git a/sdk/test/integration/Portal.integration.test.ts b/sdk/test/integration/Portal.integration.test.ts
@@ -1,4 +1,4 @@
-import VeraxSdk from "../../src/VeraxSdk";
+import { VeraxSdk } from "../../src/VeraxSdk";
 
 describe("PortalDataMapper", () => {
   let veraxSdk: VeraxSdk;

diff --git a/sdk/test/integration/Schema.integration.test.ts b/sdk/test/integration/Schema.integration.test.ts
@@ -1,4 +1,4 @@
-import VeraxSdk from "../../src/VeraxSdk";
+import { VeraxSdk } from "../../src/VeraxSdk";
 
 describe("SchemaDataMapper", () => {
   let veraxSdk: VeraxSdk;

diff --git a/sdk/tsconfig.build.json b/sdk/tsconfig.build.json
@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["test"]
+}