Accept modern KZG library API while exposing legacy API (#4841).

Author: ricmoo

src.ts/ethers.ts

@@ -180,7 +180,7 @@ export type {
 
 export type {
     AccessList, AccessListish, AccessListEntry,
-    Blob, BlobLike, KzgLibrary,
+    Blob, BlobLike, KzgLibrary, KzgLibraryLike,
     TransactionLike
 } from "./transaction/index.js";
 

src.ts/providers/provider.ts

@@ -10,7 +10,7 @@ import type { AddressLike, NameResolver } from "../address/index.js";
 import type { BigNumberish, EventEmitterable } from "../utils/index.js";
 import type { Signature } from "../crypto/index.js";
 import type {
-    AccessList, AccessListish, BlobLike, KzgLibrary, TransactionLike
+    AccessList, AccessListish, BlobLike, KzgLibraryLike, TransactionLike
 } from "../transaction/index.js";
 
 import type { ContractRunner } from "./contracts.js";
@@ -239,7 +239,7 @@ export interface TransactionRequest {
      *  This is generally ``null``, unless you are creating BLOb
      *  transactions.
      */
-    kzg?: null | KzgLibrary;
+    kzg?: null | KzgLibraryLike;
 
     // Todo?
     //gasMultiplier?: number;

src.ts/transaction/index.ts

@@ -29,5 +29,5 @@ export { computeAddress, recoverAddress } from "./address.js";
 export { Transaction } from "./transaction.js";
 
 export type {
-    Blob, BlobLike, KzgLibrary, TransactionLike
+    Blob, BlobLike, KzgLibrary, KzgLibraryLike, TransactionLike
 } from "./transaction.js";

src.ts/transaction/transaction.ts

@@ -128,7 +128,7 @@ export interface TransactionLike<A = string> {
      *  This is generally ``null``, unless you are creating BLOb
      *  transactions.
      */
-    kzg?: null | KzgLibrary;
+    kzg?: null | KzgLibraryLike;
 }
 
 /**
@@ -165,6 +165,52 @@ export interface KzgLibrary {
     computeBlobKzgProof: (blob: Uint8Array, commitment: Uint8Array) => Uint8Array;
 }
 
+/**
+ *  A KZG Library with any of the various API configurations.
+ *  As the library is still experimental and the API is not
+ *  stable, depending on the version used the method names and
+ *  signatures are still in flux.
+ *
+ *  This allows any of the versions to be passed into Transaction
+ *  while providing a stable external API.
+ */
+export type KzgLibraryLike  = KzgLibrary | {
+    blobToKZGCommitment: (blob: string) => string;
+    computeBlobKZGProof: (blob: string, commitment: string) => string;
+};
+
+function getKzgLibrary(kzg: KzgLibraryLike): KzgLibrary {
+    const blobToKzgCommitment = (blob: Uint8Array) => {
+        // API <0.5.0; blobToKzgCommitment(Uint8Array) => Uint8Array
+        if ("blobToKzgCommitment" in kzg && typeof(kzg.blobToKzgCommitment) === "function") {
+            return kzg.blobToKzgCommitment(blob);
+        }
+
+        // API >= 0.5.0; blobToKZGCommitment(string) => string
+        if ("blobToKZGCommitment" in kzg && typeof(kzg.blobToKZGCommitment) === "function") {
+            return getBytes(kzg.blobToKZGCommitment(hexlify(blob)));
+        }
+
+        assertArgument(false, "unsupported KZG library", "kzg", kzg);
+    };
+
+    const computeBlobKzgProof = (blob: Uint8Array, commitment: Uint8Array) => {
+        // API <0.5.0; computeBlobKzgProof(Uint8Array, Uint8Array) => Uint8Array
+        if ("computeBlobKzgProof" in kzg && typeof(kzg.computeBlobKzgProof) === "function") {
+            return kzg.computeBlobKzgProof(blob, commitment);
+        }
+
+        // API >= 0.5.0; computeBlobKZGProof(string, string) => string
+        if ("computeBlobKZGProof" in kzg && typeof(kzg.computeBlobKZGProof) === "function") {
+            return getBytes(kzg.computeBlobKZGProof(hexlify(blob), hexlify(commitment)));
+        }
+
+        assertArgument(false, "unsupported KZG library", "kzg", kzg);
+    };
+
+    return { blobToKzgCommitment, computeBlobKzgProof };
+}
+
 function getVersionedHash(version: number, hash: BytesLike): string {
     let versioned = version.toString(16);
     while (versioned.length < 2) { versioned = "0" + versioned; }
@@ -862,8 +908,12 @@ export class Transaction implements TransactionLike<string> {
     }
 
     get kzg(): null | KzgLibrary { return this.#kzg; }
-    set kzg(kzg: null | KzgLibrary) {
-        this.#kzg = kzg;
+    set kzg(kzg: null | KzgLibraryLike) {
+        if (kzg == null) {
+            this.#kzg = null;
+        } else {
+            this.#kzg = getKzgLibrary(kzg);
+        }
     }
 
     /**