kzg-wasm - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0

dist/cjs/index.d.ts

@@ -1,2 +0,6 @@
-export declare const initKzg: () => Promise<{
+/**
+ * Initialization function that instantiates WASM code and returns an object matching the `KZG` interface exposed by `@ethereumjs/util`
+ * @returns object - the KZG methods required for all 4844 related operations
+ */
+export declare const createKZG: () => Promise<{
     loadTrustedSetup: any;
@@ -3,0 +7,0 @@ freeTrustedSetup: any;

dist/cjs/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initKzg = void 0;
+exports.createKZG = void 0;
 const util_js_1 = require("./util.js");
 const kzg_js_1 = require("./wasm/kzg.js");
-const initKzg = async () => {
+/**
+ * Initialization function that instantiates WASM code and returns an object matching the `KZG` interface exposed by `@ethereumjs/util`
+ * @returns object - the KZG methods required for all 4844 related operations
+ */
+const createKZG = async () => {
     const module = await (0, kzg_js_1.default)();
@@ -45,3 +49,3 @@ const loadTrustedSetup = module.cwrap('load_trusted_setup_file_from_wasm', null, []);
 };
-exports.initKzg = initKzg;
+exports.createKZG = createKZG;
 //# sourceMappingURL=index.js.map

dist/cjs/wasm/kzg.d.ts

 export default kzg;
-declare function kzg(moduleArg?: {}, ...args: any[]): Promise<any>;
+declare function kzg(moduleArg?: {}): Promise<any>;
 //# sourceMappingURL=kzg.d.ts.map

dist/esm/index.d.ts

@@ -1,2 +0,6 @@
-export declare const initKzg: () => Promise<{
+/**
+ * Initialization function that instantiates WASM code and returns an object matching the `KZG` interface exposed by `@ethereumjs/util`
+ * @returns object - the KZG methods required for all 4844 related operations
+ */
+export declare const createKZG: () => Promise<{
     loadTrustedSetup: any;
@@ -3,0 +7,0 @@ freeTrustedSetup: any;

dist/esm/index.js

 import { hexToBytes } from './util.js';
 import kzgWasm from './wasm/kzg.js';
-export const initKzg = async () => {
+/**
+ * Initialization function that instantiates WASM code and returns an object matching the `KZG` interface exposed by `@ethereumjs/util`
+ * @returns object - the KZG methods required for all 4844 related operations
+ */
+export const createKZG = async () => {
     const module = await kzgWasm();
@@ -5,0 +9,0 @@ const loadTrustedSetup = module.cwrap('load_trusted_setup_file_from_wasm', null, []);

dist/esm/wasm/kzg.d.ts

 export default kzg;
-declare function kzg(moduleArg?: {}, ...args: any[]): Promise<any>;
+declare function kzg(moduleArg?: {}): Promise<any>;
 //# sourceMappingURL=kzg.d.ts.map

package.json

 {
   "name": "kzg-wasm",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "",
   "scripts": {
-    "build": "scripts/ts-build.sh",
+    "build": "npm run build:ts && npm run transpileCJS && npm run fixRequire",
+    "build:ts": "scripts/ts-build.sh",
+    "transpileCJS": "rm dist/cjs/wasm/kzg.js && babel src/wasm/kzg.js -d dist/cjs/wasm",
+    "fixRequire": "sed -i.bak \"s/\\_require('url')/require('url')/g\" dist/cjs/wasm/kzg.js && rm dist/cjs/wasm/kzg.js.bak",
     "clean": "rm -rf dist && rm -rf node_modules",
@@ -24,4 +27,8 @@ "test": "vitest run test/*",
   "devDependencies": {
-    "@vitest/browser": "^1.2.2",
-    "@vitest/utils": "^1.2.2",
+    "@babel/cli": "^7.23.9",
+    "@babel/core": "^7.23.9",
+    "@babel/preset-env": "^7.23.9",
+    "@vitest/browser": "^1.3.1",
+    "@vitest/utils": "^1.3.1",
+    "babel-plugin-transform-import-meta": "^2.2.1",
     "prettier": "^3.2.5",
@@ -31,7 +38,6 @@ "tsx": "^4.7.1",
     "vite-plugin-node-polyfills": "^0.21.0",
-    "vite-plugin-top-level-await": "^1.4.1",
     "vite-plugin-wasm": "^3.3.0",
-    "vitest": "^1.2.2",
-    "webdriverio": "^8.31.1"
+    "vitest": "^1.3.1",
+    "webdriverio": "^8.32.3"
   }
 }

README.md

@@ -9,3 +9,3 @@ # KZG-WASM
 
-This module exposes a single export, an async function called `initKzg` which loads and compiles the WASM object and returns an object that exposes the API defined in the `KZG` type interface in [`@ethereum/util`](https://github.com/ethereumjs/ethereumjs-monorepo/blob/e1221c98f3be0ba4224416f10d91ed4aa50130d8/packages/util/src/kzg.ts#L4)
+This module exposes a single export, an async function called `createKZG` which loads and compiles the WASM object and returns an object that exposes the API defined in the `KZG` type interface in [`@ethereum/util`](https://github.com/ethereumjs/ethereumjs-monorepo/blob/e1221c98f3be0ba4224416f10d91ed4aa50130d8/packages/util/src/kzg.ts#L4)
 
@@ -15,3 +15,3 @@ To use with the `@ethereumjs` libraries, do the following:
 ```ts
-import { initKzg } from 'kzg-wasm'
+import { createKZG } from 'kzg-wasm'
 import { Common, Chain, Hardfork } from '@ethereumjs/common'
@@ -21,3 +21,3 @@ import { initKZG } from '@ethereumjs/util'
 const main = async () => {
-    const kzg = await initKzg()
+    const kzg = await createKZG()
     initKZG(kzg, '')
@@ -24,0 +24,0 @@ const common = new Common({

src/index.ts

 import { hexToBytes } from './util.js'
 import kzgWasm from './wasm/kzg.js'
 
-export const initKzg = async () => {
+/**
+ * Initialization function that instantiates WASM code and returns an object matching the `KZG` interface exposed by `@ethereumjs/util`
+ * @returns object - the KZG methods required for all 4844 related operations
+ */
+export const createKZG = async () => {
     const module = await kzgWasm()
@@ -6,0 +10,0 @@

test/index.spec.ts

 import { describe, it, assert, beforeEach } from 'vitest'
-import { initKzg } from '../src/index.js'
+import { createKZG } from '../src/index.js'
 import { bytesToHex, hexToBytes } from '../src/util.js'
@@ -11,3 +11,3 @@
   it('should initialize', async () => {
-    const kzg = await initKzg()
+    const kzg = await createKZG()
     const res = kzg.loadTrustedSetup()
@@ -19,3 +19,3 @@ assert.equal(res, 0, 'loaded trusted setup')
   it('should generate kzg commitments and verify proofs', async () => {
-    const kzg = await initKzg()
+    const kzg = await createKZG()
     kzg.loadTrustedSetup()
@@ -34,3 +34,3 @@ const blob = new Uint8Array(BYTES_PER_BLOB)
   it('should verify kzg proofs with points', async () => {
-    const kzg = await initKzg()
+    const kzg = await createKZG()
     kzg.loadTrustedSetup()
@@ -37,0 +37,0 @@

vitest.config.browser.ts

 import { defineConfig } from 'vitest/config'
 import wasm from 'vite-plugin-wasm'
-import topLevelAwait from 'vite-plugin-top-level-await'
 import { nodePolyfills } from 'vite-plugin-node-polyfills'
@@ -23,3 +22,2 @@
     }),
-    topLevelAwait(),
     wasm()
@@ -26,0 +24,0 @@ ],

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Debug access

Supply chain risk

Uses debug, reflection and dynamic code execution features.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 3 instances in 1 package

Improved metrics

Number of package files

44

increased by2.33%

Number of medium supply chain risk alerts

13

decreased by-38.1%

Worsened metrics

Total package byte prevSize

2007640

decreased by-50.73%

Dev dependency count

13

increased by30%

Lines of code

3453

decreased by-76.33%

Number of low quality alerts

3

increased by50%

No dependency changes