@asyncswap/eth-rpc 0.4.11 → 0.4.13

package/dist/base.d.ts

@@ -0,0 +1,13 @@
+import { JsonRpcClient } from "@asyncswap/jsonrpc";
+export type RpcMethodSpec = {
+    params: readonly unknown[];
+    result: unknown;
+};
+export type RpcSpecBase = Record<string, RpcMethodSpec>;
+export declare abstract class BaseClient<MethodsSpec extends RpcSpecBase> {
+    rpc: JsonRpcClient<MethodsSpec>;
+    protected headers: Record<string, string>;
+    constructor(url: string);
+    setHeaders(headers: Record<string, string>): this;
+}
+//# sourceMappingURL=base.d.ts.map

package/dist/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,MAAM,MAAM,aAAa,GAAG;IAC3B,MAAM,EAAE,SAAS,OAAO,EAAE,CAAC;IAC3B,MAAM,EAAE,OAAO,CAAC;CAChB,CAAC;AACF,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAExD,8BAAsB,UAAU,CAAC,WAAW,SAAS,WAAW;IAC/D,GAAG,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;IAChC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM;gBAEnC,GAAG,EAAE,MAAM;IA8BvB,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAM1C"}

package/dist/base.js

@@ -0,0 +1,36 @@
+import { JsonRpcClient } from "@asyncswap/jsonrpc";
+export class BaseClient {
+    rpc;
+    headers = {};
+    constructor(url) {
+        this.rpc = new JsonRpcClient(url);
+        return new Proxy(this, {
+            get: (target, prop, receiver) => {
+                // let real properties / methods through
+                if (prop in target) {
+                    const value = Reflect.get(target, prop, receiver);
+                    if (typeof value === "function") {
+                        return (...args) => {
+                            const result = value.apply(target, args);
+                            // if method returns target, return proxy instead
+                            return result === target ? receiver : result;
+                        };
+                    }
+                    return value;
+                }
+                // dynamic rpc
+                if (typeof prop !== "string")
+                    return undefined;
+                const method = prop;
+                return (...params) => this.rpc.call(this.rpc.buildRequest(method, params), this.headers);
+            },
+        });
+    }
+    setHeaders(headers) {
+        this.headers = {
+            ...headers,
+        };
+        return this;
+    }
+}
+//# sourceMappingURL=base.js.map

package/dist/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAQnD,MAAM,OAAgB,UAAU;IAC/B,GAAG,CAA6B;IACtB,OAAO,GAA2B,EAAE,CAAC;IAE/C,YAAY,GAAW;QACtB,IAAI,CAAC,GAAG,GAAG,IAAI,aAAa,CAAC,GAAG,CAAC,CAAC;QAElC,OAAO,IAAI,KAAK,CAAC,IAAI,EAAE;YACtB,GAAG,EAAE,CAAC,MAAY,EAAE,IAAqB,EAAE,QAAQ,EAAE,EAAE;gBACtD,wCAAwC;gBACxC,IAAI,IAAI,IAAI,MAAM,EAAE,CAAC;oBACpB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;oBAClD,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;wBACjC,OAAO,CAAC,GAAG,IAAW,EAAE,EAAE;4BACzB,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;4BACzC,iDAAiD;4BACjD,OAAO,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;wBAC9C,CAAC,CAAC;oBACH,CAAC;oBACD,OAAO,KAAK,CAAC;gBACd,CAAC;gBACD,cAAc;gBACd,IAAI,OAAO,IAAI,KAAK,QAAQ;oBAAE,OAAO,SAAS,CAAC;gBAE/C,MAAM,MAAM,GAAG,IAAyB,CAAC;gBAEzC,OAAO,CACN,GAAG,MAA4C,EACR,EAAE,CACzC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YACrE,CAAC;SACD,CAAC,CAAC;IACJ,CAAC;IAED,UAAU,CAAC,OAA+B;QACzC,IAAI,CAAC,OAAO,GAAG;YACd,GAAG,OAAO;SACV,CAAC;QACF,OAAO,IAAI,CAAC;IACb,CAAC;CACD"}

package/dist/engine-api.d.ts

@@ -0,0 +1,13 @@
+import { BaseClient } from "./base";
+export declare class EngineExecutionClient extends BaseClient<EngineMethodsSpec> {
+    constructor(url: string, jwt_token: string);
+}
+export type EngineRpcMethods<T extends Record<string, {
+    params: unknown[];
+    result: unknown;
+}>> = {
+    [K in keyof T]: (...params: T[K]["params"]) => Promise<T[K]["result"]>;
+};
+export interface EngineExecutionClient extends EngineRpcMethods<EngineMethodsSpec> {
+}
+//# sourceMappingURL=engine-api.d.ts.map

package/dist/engine-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine-api.d.ts","sourceRoot":"","sources":["../src/engine-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC,qBAAa,qBAAsB,SAAQ,UAAU,CAAC,iBAAiB,CAAC;gBAC3D,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;CAM1C;AAED,MAAM,MAAM,gBAAgB,CAC3B,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE;IAAE,MAAM,EAAE,OAAO,EAAE,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE,CAAC,IAC7D;KACD,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;CACtE,CAAC;AAEH,MAAM,WAAW,qBAChB,SAAQ,gBAAgB,CAAC,iBAAiB,CAAC;CAAI"}

package/dist/engine-api.js

@@ -0,0 +1,10 @@
+import { BaseClient } from "./base";
+export class EngineExecutionClient extends BaseClient {
+    constructor(url, jwt_token) {
+        super(url);
+        this.headers = {
+            Authorization: `Bearer ${jwt_token}`,
+        };
+    }
+}
+//# sourceMappingURL=engine-api.js.map

package/dist/engine-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine-api.js","sourceRoot":"","sources":["../src/engine-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC,MAAM,OAAO,qBAAsB,SAAQ,UAA6B;IACvE,YAAY,GAAW,EAAE,SAAiB;QACzC,KAAK,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,OAAO,GAAG;YACd,aAAa,EAAE,UAAU,SAAS,EAAE;SACpC,CAAC;IACH,CAAC;CACD"}

package/dist/eth-api.d.ts

@@ -0,0 +1,13 @@
+import { BaseClient } from "@asyncswap/jsonrpc";
+export declare class ExecutionClient extends BaseClient<EthMethodsSpec> {
+    constructor(url: string);
+}
+export type EthRpcMethods<MethodsSpec extends Record<string, {
+    params: readonly unknown[];
+    result: unknown;
+}>> = {
+    [Method in keyof MethodsSpec]: (...params: MethodsSpec[Method]["params"]) => Promise<MethodsSpec[Method]["result"]>;
+};
+export interface ExecutionClient extends EthRpcMethods<EthMethodsSpec> {
+}
+//# sourceMappingURL=eth-api.d.ts.map

package/dist/eth-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eth-api.d.ts","sourceRoot":"","sources":["../src/eth-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEhD,qBAAa,eAAgB,SAAQ,UAAU,CAAC,cAAc,CAAC;gBAClD,GAAG,EAAE,MAAM;CAGvB;AAED,MAAM,MAAM,aAAa,CACxB,WAAW,SAAS,MAAM,CACzB,MAAM,EACN;IAAE,MAAM,EAAE,SAAS,OAAO,EAAE,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE,CAC/C,IACE;KACD,MAAM,IAAI,MAAM,WAAW,GAAG,CAC9B,GAAG,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,KACpC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAC;CAC3C,CAAC;AAEH,MAAM,WAAW,eAAgB,SAAQ,aAAa,CAAC,cAAc,CAAC;CAAI"}

package/dist/eth-api.js

@@ -0,0 +1,7 @@
+import { BaseClient } from "@asyncswap/jsonrpc";
+export class ExecutionClient extends BaseClient {
+    constructor(url) {
+        super(url);
+    }
+}
+//# sourceMappingURL=eth-api.js.map

package/dist/eth-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eth-api.js","sourceRoot":"","sources":["../src/eth-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEhD,MAAM,OAAO,eAAgB,SAAQ,UAA0B;IAC9D,YAAY,GAAW;QACtB,KAAK,CAAC,GAAG,CAAC,CAAC;IACZ,CAAC;CACD"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./eth-api";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from "./eth-api";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC"}

package/dist/mev-api.d.ts

@@ -0,0 +1,13 @@
+import { BaseClient } from "./base";
+export declare class FlashbotsClient extends BaseClient<FlashbotsMethodsSpec> {
+    constructor(url: string);
+}
+export type FlashbotsRpcMethods<T extends Record<string, {
+    params: unknown[];
+    result: unknown;
+}>> = {
+    [M in keyof T]: (...params: T[M]["params"]) => Promise<T[M]["result"]>;
+};
+export interface FlashbotsClient extends FlashbotsRpcMethods<FlashbotsMethodsSpec> {
+}
+//# sourceMappingURL=mev-api.d.ts.map

package/dist/mev-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mev-api.d.ts","sourceRoot":"","sources":["../src/mev-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC,qBAAa,eAAgB,SAAQ,UAAU,CAAC,oBAAoB,CAAC;gBACxD,GAAG,EAAE,MAAM;CAKvB;AAED,MAAM,MAAM,mBAAmB,CAC9B,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE;IAAE,MAAM,EAAE,OAAO,EAAE,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE,CAAC,IAC7D;KACD,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;CACtE,CAAC;AACH,MAAM,WAAW,eAChB,SAAQ,mBAAmB,CAAC,oBAAoB,CAAC;CAAI"}

package/dist/mev-api.js

@@ -0,0 +1,7 @@
+import { BaseClient } from "./base";
+export class FlashbotsClient extends BaseClient {
+    constructor(url) {
+        super(url);
+    }
+}
+//# sourceMappingURL=mev-api.js.map

package/dist/mev-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mev-api.js","sourceRoot":"","sources":["../src/mev-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC,MAAM,OAAO,eAAgB,SAAQ,UAAgC;IACpE,YAAY,GAAW;QACtB,KAAK,CAAC,GAAG,CAAC,CAAC;IACZ,CAAC;CAGD"}

package/package.json

@@ -2,7 +2,7 @@
 	"name": "@asyncswap/eth-rpc",
 	"description": "A library for ethereum execution clients apis.",
 	"author": "Meek Msaki",
-	"version": "0.4.11",
+	"version": "0.4.13",
 	"license": "MIT",
 	"type": "module",
 	"main": "dist/index.js",
@@ -15,6 +15,10 @@
 		"engine-api",
 		"execution-apis"
 	],
+	"files": [
+		"dist",
+		"src"
+	],
 	"homepage": "https://github.com/asyncswap/eth-libs/tree/main/packages/eth-rpc",
 	"repository": {
 		"type": "git",
@@ -40,6 +44,6 @@
 		"typescript": "^5"
 	},
 	"dependencies": {
-		"@asyncswap/jsonrpc": "^0.4.10"
+		"@asyncswap/jsonrpc": "^0.4.12"
 	}
 }

package/CHANGELOG.md

@@ -1,169 +0,0 @@
-# @asyncswap/eth-rpc
-
-## 0.4.11
-
-### Patch Changes
-
-- 69a2d7e: patch types updates
-- Updated dependencies [69a2d7e]
-  - @asyncswap/jsonrpc@0.4.10
-
-## 0.4.10
-
-### Patch Changes
-
-- dc792b1: (refactor): change to `withHeaders` option and update BaseClient source
-- Updated dependencies [dc792b1]
-  - @asyncswap/jsonrpc@0.4.9
-
-## 0.4.9
-
-### Patch Changes
-
-- e9fc1df: remove biome dep
-- Updated dependencies [e9fc1df]
-  - @asyncswap/jsonrpc@0.4.8
-
-## 0.4.8
-
-### Patch Changes
-
-- cad9042: minimal eth rpc client
-
-  - ported engine api to different package
-
-## 0.4.7
-
-### Patch Changes
-
-- ff4e035: fix base client proxy
-
-  ```ts
-  setHeaders(...) {
-      this.headers = ...
-      return this; // ❌ returns the *target*
-  }
-  ```
-
-  The correct fix: return the receiver / proxy, not this
-
-  You already have access to the proxy inside the get trap via receiver.
-
-  So you must bind methods so that they return the proxy.
-
-  - setHeaders() mutates the target
-  - returns receiver (the proxy)
-  - chaining continues in proxy-land
-  - RPC methods remain visible
-
-## 0.4.6
-
-### Patch Changes
-
-- 3d6ec6e: add clinet version spec
-
-## 0.4.5
-
-### Patch Changes
-
-- 0d1be5d: upgrade with parameter typing
-- Updated dependencies [882f94f]
-  - @asyncswap/jsonrpc@0.4.7
-
-## 0.4.4
-
-### Patch Changes
-
-- b2b631f: deprecated `EthExecutionClien` use `ExecutionClient`
-- Updated dependencies [f7d28d9]
-  - @asyncswap/jsonrpc@0.4.4
-
-## 0.4.3
-
-### Patch Changes
-
-- 7ae86a0: new refactor on methods as data
-- Updated dependencies [40a79dc]
-  - @asyncswap/jsonrpc@0.4.3
-
-## 0.4.2
-
-### Patch Changes
-
-- 9512db5: update documentation
-- Updated dependencies [9512db5]
-  - @asyncswap/jsonrpc@0.4.2
-
-## 0.4.1
-
-### Patch Changes
-
-- 2598f09: updates docs
-
-## 0.4.0
-
-### Minor Changes
-
-- fd79ea3: updates api for eth-client and adds flasbots methods and headers
-
-### Patch Changes
-
-- Updated dependencies [43de065]
-- Updated dependencies [7e8300c]
-- Updated dependencies [7126afa]
-  - @asyncswap/jsonrpc@0.5.0
-
-## 0.3.0
-
-### Minor Changes
-
-- d2562a2: implemented execution apis methods
-
-  eth/transation
-
-  - eth_getTransactionByHash
-  - eth_getTransactionByBlockHashAndIndex
-  - eth_getTransactionReceipt
-
-  eth/submit
-
-  - eth_sendTransaction
-  - eth_sendRawTransaction
-
-  eth/state
-
-  - eth_getBalance
-  - eth_getStorageAt
-  - eth_getTransactionCount
-  - eth_getCode
-  - eth_getProof
-
-  eth/sign
-
-  - eth_sign
-  - eth_signTransaction
-
-  eth/filter
-
-  - eth_newFilter
-  - eth_newBlockFilter
-  - eth_newPendingTransactionFilter
-  - eth_uninstallFilter
-  - eth_getFilterChanges
-  - eth_getFilterLogs
-  - eth_getLogs
-
-- dc1718c: refactor of types dir to global types
-
-### Patch Changes
-
-- e3ac747: patch
-- a9d1a29: add biome formatting
-- Updated dependencies [dc1718c]
-- Updated dependencies [e15733c]
-- Updated dependencies [e3ac747]
-- Updated dependencies [abddcdc]
-- Updated dependencies [00ba692]
-- Updated dependencies [07dc4e5]
-- Updated dependencies [ded3e6b]
-  - @asyncswap/jsonrpc@0.3.0

package/example.ts

@@ -1,10 +0,0 @@
-import { ExecutionClient } from "./src";
-
-const url = "http://localhost:8545";
-const eth = new ExecutionClient(url);
-const balance = await eth.eth_getBalance(
-	"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
-	"latest",
-);
-console.log("Balance:", balance);
-eth.eth_getTransactionCount("0x34", "safe");

package/tsconfig.json

@@ -1,33 +0,0 @@
-{
-	"compilerOptions": {
-		// Environment setup & latest features
-		"lib": ["ESNext"],
-		"target": "ESNext",
-		"module": "Preserve",
-		"moduleDetection": "force",
-		"jsx": "react-jsx",
-		"allowJs": true,
-		// Bundler mode
-		"sourceMap": true,
-		"declaration": true,
-		"declarationMap": true,
-		"moduleResolution": "bundler",
-		"outDir": "dist",
-		"rootDir": "src",
-		"allowImportingTsExtensions": false,
-		"verbatimModuleSyntax": true,
-		"noEmit": false,
-		// Best practices
-		"strict": true,
-		"skipLibCheck": true,
-		"noFallthroughCasesInSwitch": true,
-		"noUncheckedIndexedAccess": true,
-		"noImplicitOverride": true,
-		// Some stricter flags (disabled by default)
-		"noUnusedLocals": false,
-		"noUnusedParameters": false,
-		"noPropertyAccessFromIndexSignature": false
-	},
-	"include": ["src/**/*", "global.d.ts"],
-	"exclude": ["example.ts"]
-}