Rename IDl to Idl

Author: Woody4618

CHANGELOG.md

@@ -2,8 +2,8 @@
 
 - Added `sendVersionedTransaction()` to send a versioned transaction with lookup tables. Also adds priority fee support.
 - Added `createLookupTable()` to easily create a lookup table and extend it with additional addresses
-- Added `getIDlByProgramId()` to fetch an IDL from a program on-chain
-- Added `getIDlByIdlPath()` to parse an IDL from a local file path
+- Added `getIdlByProgramId()` to fetch an IDL from a program on-chain
+- Added `getIdlByPath()` to parse an IDL from a local file path
 - Added `getIdlParsedAccountData()` to parse account data using an IDL
 - Added `parseAnchorTransactionEvents()` to parse anchor transaction events using an IDL
 - Added `decodeAnchorTransaction()` to decode a transaction completely using an IDL

README.md

@@ -645,13 +645,13 @@ These utilities help with:
 Get an IDL from a local file:
 
 ```typescript
-const idl = await getIDlbyPath("./idl/program.json");
+const idl = await getIdlByPath("./idl/program.json");
 ```
 
 Or fetch it from the chain:
 
 ```typescript
-const idl = await getIDlByProgramId(
+const idl = await getIdlByProgramId(
   new PublicKey("verifycLy8mB96wd9wqq3WDXQwM4oU6r42Th37Db9fC"),
   connection,
 );
@@ -662,7 +662,7 @@ const idl = await getIDlByProgramId(
 Usage:
 
 ```typescript
-const idl = await getIDlByProgramId(programId, connection);
+const idl = await getIdlByProgramId(programId, connection);
 const data = await getIdlParsedAccountData(
   idl,
   "counter",
@@ -680,7 +680,7 @@ Fetches and parses an account's data using an Anchor IDL file. This is useful wh
 Usage:
 
 ```typescript
-const idl = await getIDlbyPath("./idl/program.json");
+const idl = await getIdlByPath("./idl/program.json");
 const events = await parseAnchorTransactionEvents(idl, signature, connection);
 
 // Events will be an array of:
@@ -697,7 +697,7 @@ Parses all Anchor events emitted in a transaction. This helps you track and veri
 Usage:
 
 ```typescript
-const idl = await getIDlByProgramId(programId, connection);
+const idl = await getIdlByProgramId(programId, connection);
 const decoded = await decodeAnchorTransaction(idl, signature, connection);
 
 // Print human-readable format

src/lib/idl.ts

@@ -25,10 +25,10 @@ import { formatIdl } from "./convertLegacyIdl";
  *
  * @example
  * ```typescript
- * const idl = await getIDlbyPath("./idl/program.json");
+ * const idl = await getIdlByPath("./idl/program.json");
  * ```
  */
-export async function getIDlbyPath<Idl>(idlPath: string): Promise<Idl> {
+export async function getIdlByPath<Idl>(idlPath: string): Promise<Idl> {
   const fs = await import("node:fs");
   const path = await import("node:path");
 
@@ -48,13 +48,13 @@ export async function getIDlbyPath<Idl>(idlPath: string): Promise<Idl> {
  *
  * @example
  * ```typescript
- * const idl = await getIDlByProgramId(
+ * const idl = await getIdlByProgramId(
  *   new PublicKey("Foo1111111111111111111111111111111111111"),
  *   connection
  * );
  * ```
  */
-export async function getIDlByProgramId<Idl>(
+export async function getIdlByProgramId<Idl>(
   programId: PublicKey,
   connection: Connection,
 ): Promise<Idl> {
@@ -73,7 +73,7 @@ export async function getIDlByProgramId<Idl>(
 /**
  * Fetches and parses an account's data using an Anchor IDL
  *
- * @param idl - The Anchor IDL (use getIDlByProgramId or getIDlbyPath to obtain)
+ * @param idl - The Anchor IDL (use getIdlByProgramId or getIdlByPath to obtain)
  * @param accountName - The name of the account as defined in the IDL
  * @param accountAddress - The public key of the account to fetch
  * @param connection - Optional connection object (uses default provider if not specified)
@@ -82,7 +82,7 @@ export async function getIDlByProgramId<Idl>(
  *
  * @example
  * ```typescript
- * const idl = await getIDlByProgramId(programId, connection);
+ * const idl = await getIdlByProgramId(programId, connection);
  * const data = await getIdlParsedAccountData(idl, "counter", accountAddress);
  * ```
  */
@@ -115,15 +115,15 @@ export async function getIdlParsedAccountData<T = any>(
 /**
  * Parses Anchor events from a transaction
  *
- * @param idl - The Anchor IDL (use getIDlByProgramId or getIDlbyPath to obtain)
+ * @param idl - The Anchor IDL (use getIdlByProgramId or getIdlByPath to obtain)
  * @param signature - Transaction signature to parse events from
  * @param connection - Connection object (uses default provider if not specified)
  * @param programId - Optional program ID needed for legacy IDLs
  * @returns Array of parsed events with their name and data
  *
  * @example
  * ```typescript
- * const idl = await getIDlbyPath("./idl/program.json");
+ * const idl = await getIdlByPath("./idl/program.json");
  * const events = await parseAnchorTransactionEvents(idl, signature);
  * ```
  */
@@ -200,15 +200,15 @@ export type DecodedTransaction = {
 /**
  * Decodes all Anchor instructions and their involved accounts in a transaction
  *
- * @param idl - The Anchor IDL (use getIDlByProgramId or getIDlbyPath to obtain)
+ * @param idl - The Anchor IDL (use getIdlByProgramId or getIdlByPath to obtain)
  * @param signature - Transaction signature to decode
  * @param connection - Optional connection object (uses default provider if not specified)
  * @param programId - Optional program ID needed for legacy IDLs
  * @returns Decoded transaction with instructions and accounts
  *
  * @example
  * ```typescript
- * const idl = await getIDlByProgramId(programId, connection);
+ * const idl = await getIdlByProgramId(programId, connection);
  * const decoded = await decodeAnchorTransaction(idl, signature);
  * ```
  */
@@ -275,7 +275,11 @@ export async function decodeAnchorTransaction(
                   const accountType = idl.accounts?.find((acc) =>
                     accountInfo.data
                       .slice(0, 8)
-                      .equals(accountsCoder.accountDiscriminator(acc.name.toLowerCase())),
+                      .equals(
+                        accountsCoder.accountDiscriminator(
+                          acc.name.toLowerCase(),
+                        ),
+                      ),
                   );
                   if (accountType) {
                     accountData = accountsCoder.decode(

tests/src/idl.test.ts

@@ -2,7 +2,7 @@ import { describe, test } from "node:test";
 import { Connection, PublicKey } from "@solana/web3.js";
 import {
   decodeAnchorTransaction,
-  getIDlByProgramId,
+  getIdlByProgramId,
   getIdlParsedAccountData,
   parseAnchorTransactionEvents,
 } from "../../src";
@@ -15,7 +15,7 @@ const MAINNET = "https://api.mainnet-beta.solana.com";
 describe("confirmTransaction", () => {
   test("Parsing verify transaction contains two events", async () => {
     const connection = new Connection(MAINNET);
-    const idl: Idl = await getIDlByProgramId(
+    const idl: Idl = await getIdlByProgramId(
       new PublicKey("verifycLy8mB96wd9wqq3WDXQwM4oU6r42Th37Db9fC"),
       connection,
     );
@@ -36,7 +36,7 @@ describe("confirmTransaction", () => {
       "ancA4duevpt3eSgS5J7cD8oJntmfLKJDM59GhMtegES",
     );
 
-    const idl: Idl | null = await getIDlByProgramId(programId, connection);
+    const idl: Idl | null = await getIdlByProgramId(programId, connection);
     if (!idl)
       throw new Error(`IDL not found for program ${programId.toString()}`);
 
@@ -90,7 +90,7 @@ describe("confirmTransaction", () => {
       "ancA4duevpt3eSgS5J7cD8oJntmfLKJDM59GhMtegES",
     );
 
-    const idl: Idl | null = await getIDlByProgramId(programId, connection);
+    const idl: Idl | null = await getIdlByProgramId(programId, connection);
     if (!idl)
       throw new Error(`IDL not found for program ${programId.toString()}`);
 
@@ -134,7 +134,7 @@ describe("confirmTransaction", () => {
 
   test("Parsing verify account returns correct data", async () => {
     const connection = new Connection(MAINNET);
-    const idl: Idl = await getIDlByProgramId(
+    const idl: Idl = await getIdlByProgramId(
       new PublicKey("verifycLy8mB96wd9wqq3WDXQwM4oU6r42Th37Db9fC"),
       connection,
     );
@@ -172,6 +172,9 @@ describe("confirmTransaction", () => {
     );
     assert.ok(Array.isArray(buildParams.args), "Should have args array");
     assert.ok(buildParams.deploySlot, "Should have deploySlot");
-    assert.ok(typeof buildParams.bump === "number", "Should have bump of type number");
+    assert.ok(
+      typeof buildParams.bump === "number",
+      "Should have bump of type number",
+    );
   });
 });