fix types

Author: erhant

.env.example

@@ -1,6 +1,6 @@
 ## Ethereum related
-# Private key with 0x prefix
-PRIVATE_KEY=
+# Secret (private) key with 0x prefix
+SECRET_KEY=
 # RPC URL (e.g. Alchemy or Infura)
 RPC_URL=https://base-sepolia.g.alchemy.com/v2/<api-key>
 

README.md

@@ -40,7 +40,7 @@ Dria Oracle uses [Viem](https://viem.sh/) to connect with blockchains. It takes
 ```ts
 // wallet client for "write" operations
 const walletClient = createWalletClient({
-  account: privateKeyToAccount(PRIVATE_KEY),
+  account: privateKeyToAccount(SECRET_KEY),
   transport: http(RPC_URL),
   chain,
 });

package.json

@@ -1,6 +1,6 @@
 {
   "name": "dria-oracle-sdk",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "An on-chain AI oracle SDK for Dria",
   "license": "MIT",
   "author": "FirstBatch Team <[email protected]>",
@@ -16,11 +16,14 @@
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
+  "types": "./dist/index.d.cts",
   "exports": {
     "require": {
+      "types": "./dist/index.d.cts",
       "default": "./dist/index.cjs"
     },
     "import": {
+      "types": "./dist/index.d.mts",
       "default": "./dist/index.mjs"
     }
   },

src/client.ts

@@ -97,8 +97,11 @@ export class Oracle<T extends Transport, C extends Chain, K = unknown> {
     return this;
   }
 
-  /** Returns a new instance of the LLM coordinator contract. */
-  Coordinator(address: Address) {
+  /** Returns a new instance of the LLM coordinator contract.
+   * @warning This is an internal method, and making it `private` will break
+   * the type export due to the size of ABI-inferred types.
+   */
+  private Coordinator(address: Address) {
     return getContract({
       address,
       abi: coordinatorAbi,
@@ -109,8 +112,11 @@ export class Oracle<T extends Transport, C extends Chain, K = unknown> {
     });
   }
 
-  /** Returns a new instance of an ERC20 token contract. */
-  Token(address: Address) {
+  /** Returns a new instance of an ERC20 token contract.
+   * @warning This is an internal method, and making it `private` will break
+   * the type export due to the size of ABI-inferred types.
+   */
+  private Token(address: Address) {
     return getContract({
       address,
       abi: erc20Abi,

tests/oracle.test.ts

@@ -10,14 +10,14 @@ describe.only("oracle", () => {
   let requestTxHash: Hex;
 
   beforeAll(async () => {
-    const PRIVATE_KEY =
-      (process.env.PRIVATE_KEY! as Hex) ?? "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"; // anvil #0
+    const SECRET_KEY =
+      (process.env.SECRET_KEY! as Hex) ?? "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"; // anvil #0
     const RPC_URL = process.env.RPC_URL ?? "https://base-sepolia-rpc.publicnode.com"; // public URL
     const COORDINATOR_ADDRESS =
       (process.env.COORDINATOR_ADDRESS as Address) ?? "0x362fDBB20191ba22d53bF3b09646AA387Cd6dF75";
 
     const walletClient = createWalletClient({
-      account: privateKeyToAccount(PRIVATE_KEY),
+      account: privateKeyToAccount(SECRET_KEY),
       chain: baseSepolia,
       transport: http(RPC_URL),
     });