@asyncswap/engine-rpc 0.0.7 → 0.0.9

package/src/types/index.ts

@@ -0,0 +1,6 @@
+export * from "./blob";
+export * from "./forkchoice";
+export * from "./identification";
+export * from "./methods";
+export * from "./payload";
+export * from "./transition-configuration";

package/src/types/methods.ts

@@ -0,0 +1,166 @@
+import type {
+	Address,
+	Block,
+	BlockNumberOrTag,
+	BlockNumberOrTagOrHash,
+	Bytes,
+	Bytes8,
+	Filter,
+	FilterResults,
+	GenericTransaction,
+	Hash32,
+	NotFound,
+	SyncingStatus,
+	Uint,
+	Uint64,
+	Uint256,
+} from "@asyncswap/eth-types";
+import type { BlobAndProofV1, BlobAndProofV2 } from "./blob";
+import type {
+	ForkchoiceStateV1,
+	ForkchoiceUpdatedResponseV1,
+	PayloadAttributesV1,
+	PayloadAttributesV2,
+	PayloadAttributesV3,
+} from "./forkchoice";
+
+import type { ClientVersionV1 } from "./identification";
+import type {
+	BlobsBundleV1,
+	BlobsBundleV2,
+	ExecutionPayloadBodyV1,
+	ExecutionPayloadV1,
+	ExecutionPayloadV2,
+	ExecutionPayloadV3,
+	ExecutionPayloadV4,
+	PayloadStatusNoInvalidBlockHash,
+	PayloadStatusV1,
+} from "./payload";
+import type { TransitionConfigurationV1 } from "./transition-configuration";
+
+export type EngineMethodsSpec = {
+	// identification
+	engine_getClientVersionV1: {
+		params: [ClientVersionV1];
+		result: ClientVersionV1[];
+	};
+	// share methods
+	eth_blockNumber: { params: []; result: Uint };
+	eth_call: {
+		params: [GenericTransaction, BlockNumberOrTagOrHash];
+		result: Bytes;
+	};
+	eth_chainId: { params: []; result: Uint };
+	eth_getCode: { params: [Address, BlockNumberOrTagOrHash]; result: Bytes };
+	eth_getBlockByHash: { params: [Hash32, boolean]; result: NotFound | Block };
+	eth_getBlockByNumber: {
+		params: [BlockNumberOrTag, boolean];
+		result: NotFound | Block;
+	};
+	eth_getLogs: { params: [Filter]; result: FilterResults };
+	eth_sendRawTransaction: { params: [Bytes]; result: Hash32 };
+	eth_syncing: { params: []; result: SyncingStatus };
+	// engine/blob
+	engine_getBlobsV1: { params: [Hash32[]]; result: BlobAndProofV1[] };
+	engine_getBlobsV2: { params: [Hash32[]]; result: BlobAndProofV2[] };
+	engine_getBlobsV3: {
+		params: [Hash32[]];
+		result: Array<BlobAndProofV2[] | null> | null;
+	};
+	// engine/capabilities
+	engine_exchangeCapabilities: { params: [string[]]; result: string[] };
+	// engine/forkchoice
+	engine_forkchoiceUpdatedV1: {
+		params: [ForkchoiceStateV1, PayloadAttributesV1];
+		result: ForkchoiceUpdatedResponseV1;
+	};
+	engine_forkchoiceUpdatedV2: {
+		params: [ForkchoiceStateV1, PayloadAttributesV2];
+		result: ForkchoiceUpdatedResponseV1;
+	};
+	engine_forkchoiceUpdatedV3: {
+		params: [ForkchoiceStateV1, PayloadAttributesV3];
+		result: ForkchoiceUpdatedResponseV1;
+	};
+	// engine/payload
+	engine_newPayloadV1: {
+		params: [ExecutionPayloadV1];
+		result: PayloadStatusV1;
+	};
+	engine_newPayloadV2: {
+		params: [ExecutionPayloadV1 | ExecutionPayloadV2];
+		result: PayloadStatusNoInvalidBlockHash;
+	};
+	engine_newPayloadV3: {
+		params: [ExecutionPayloadV3, Hash32[], Hash32];
+		result: PayloadStatusNoInvalidBlockHash;
+	};
+	engine_newPayloadV4: {
+		params: [ExecutionPayloadV3, Hash32[], Hash32, Bytes[]];
+		result: PayloadStatusNoInvalidBlockHash;
+	};
+	engine_getPayloadV1: { params: [Bytes8]; result: ExecutionPayloadV1 };
+	engine_getPayloadV2: {
+		params: [Bytes8];
+		result: {
+			executionPayload: ExecutionPayloadV1 | ExecutionPayloadV2;
+			blockValue: Uint256;
+		};
+	};
+	engine_getPayloadV3: {
+		params: [Bytes8];
+		result: {
+			executionPayload: ExecutionPayloadV3;
+			blockValue: Uint256;
+			blobsBundle: BlobsBundleV1;
+			shouldOverrideBuilder: boolean;
+		};
+	};
+	engine_getPayloadV4: {
+		params: [Bytes8];
+		result: {
+			executionPayload: ExecutionPayloadV3;
+			blockValue: Uint256;
+			blobsBundle: BlobsBundleV1;
+			shouldOverrideBuilder: boolean;
+			executionRequests: Bytes[];
+		};
+	};
+	engine_getPayloadV5: {
+		params: [Bytes8];
+		result: {
+			executionPayload: ExecutionPayloadV3;
+			blockValue: Uint256;
+			blobsBundle: BlobsBundleV2;
+			shouldOverrideBuilder: boolean;
+			executionRequests: Bytes[];
+		};
+	};
+	engine_getPayloadBodiesByHashV1: {
+		params: [Hash32[]];
+		result: ExecutionPayloadBodyV1[];
+	};
+	engine_getPayloadBodiesByRangeV1: {
+		params: [Uint64, Uint64];
+		result: ExecutionPayloadBodyV1[];
+	};
+	engine_newPayloadV5: {
+		params: [ExecutionPayloadV4, Hash32[], Hash32, Bytes[]];
+		result: PayloadStatusNoInvalidBlockHash;
+	};
+	engine_getPayloadV6: {
+		params: [Bytes8];
+		result: {
+			executionPayload: ExecutionPayloadV4;
+			blockValue: Uint256;
+			blobsBundle: BlobsBundleV2;
+			shouldOverrideBuilder: boolean;
+			executionRequests: Bytes[];
+		};
+	};
+	// engine/transition-configuration
+	engine_exchangeTransitionConfigurationV1: {
+		params: [TransitionConfigurationV1];
+		result: TransitionConfigurationV1;
+	};
+};

package/src/types/payload.ts

@@ -0,0 +1,126 @@
+import type {
+	Address,
+	Bytes,
+	Bytes32,
+	Bytes48,
+	Bytes256,
+	Hash32,
+	Uint64,
+} from "@asyncswap/eth-types";
+export enum PAYLOAD_STATUS {
+	VALID = "VALID",
+	INVALID = "INVALID",
+	SYNCING = "SYNCING",
+	ACCEPTED = "ACCEPTED",
+	INVALID_BLOCK_HASH = "INVALID_BLOCK_HASH",
+}
+export interface PayloadStatusV1 {
+	status: PAYLOAD_STATUS;
+	latestValidHash?: Hash32;
+	validationError?: string;
+}
+export interface RestrictedPayloadStatusV1 {
+	status:
+	| PAYLOAD_STATUS.VALID
+	| PAYLOAD_STATUS.INVALID
+	| PAYLOAD_STATUS.SYNCING;
+	latestValidHash: Hash32;
+	validationError: string;
+}
+export interface PayloadStatusNoInvalidBlockHash {
+	status: Exclude<PAYLOAD_STATUS, PAYLOAD_STATUS.INVALID_BLOCK_HASH>;
+	latestValidHash: Hash32;
+	validationError: string;
+}
+export interface ExecutionPayloadV1 {
+	parentHash: Hash32;
+	feeRecipient: Address;
+	stateRoot: Bytes32;
+	receiptsRoot: Bytes32;
+	logsBloom: Bytes256;
+	prevRandao: Bytes32;
+	blockNumber: Uint64;
+	gasLimit: Uint64;
+	gasUsed: Uint64;
+	timestamp: Uint64;
+	extraData: Bytes32;
+	baseFeePerGas: Uint64;
+	blockHash: Hash32;
+	transactions: Bytes[];
+}
+export interface WithdrawalV1 {
+	index: Uint64;
+	validatorIndex: Uint64;
+	address: Address;
+	amount: Uint64;
+}
+export interface ExecutionPayloadV2 {
+	parentHash: Hash32;
+	feeRecipient: Address;
+	stateRoot: Bytes32;
+	receiptsRoot: Bytes32;
+	logsBloom: Bytes256;
+	prevRandao: Bytes32;
+	blockNumber: Uint64;
+	gasLimit: Uint64;
+	gasUsed: Uint64;
+	timestamp: Uint64;
+	extraData: Bytes32;
+	baseFeePerGas: Uint64;
+	blockHash: Hash32;
+	transactions: Bytes[];
+	withdrawals: WithdrawalV1[];
+}
+export interface ExecutionPayloadV3 {
+	parentHash: Hash32;
+	feeRecipient: Address;
+	stateRoot: Bytes32;
+	receiptsRoot: Bytes32;
+	logsBloom: Bytes256;
+	prevRandao: Bytes32;
+	blockNumber: Uint64;
+	gasLimit: Uint64;
+	gasUsed: Uint64;
+	timestamp: Uint64;
+	extraData: Bytes32;
+	baseFeePerGas: Uint64;
+	blockHash: Hash32;
+	transactions: Bytes[];
+	withdrawals: WithdrawalV1[];
+	blobGasUsed: Uint64;
+	excessBlobGas: Uint64;
+}
+export interface ExecutionPayloadV4 {
+	parentHash: Hash32;
+	feeRecipient: Address;
+	stateRoot: Bytes32;
+	receiptsRoot: Bytes32;
+	logsBloom: Bytes256;
+	prevRandao: Bytes32;
+	blockNumber: Uint64;
+	gasLimit: Uint64;
+	gasUsed: Uint64;
+	timestamp: Uint64;
+	extraData: Bytes32;
+	baseFeePerGas: Uint64;
+	blockHash: Hash32;
+	transactions: Bytes[];
+	withdrawals: WithdrawalV1[];
+	blobGasUsed: Uint64;
+	excessBlobGas: Uint64;
+	blockAccessList: Bytes;
+}
+export interface ExecutionPayloadBodyV1 {
+	transactions: Bytes[];
+	withdrawals?: WithdrawalV1[];
+}
+export interface BlobsBundleV1 {
+	commitments: Bytes48[];
+	proofs: Bytes48[];
+	blobs: Bytes[];
+}
+export interface BlobsBundleV2 {
+	commitments: Bytes48[];
+	proofs: Bytes48[];
+	blobs: Bytes[];
+}

package/src/types/transition-configuration.ts

@@ -0,0 +1,7 @@
+import type { Hash32, Uint64, Uint256 } from "@asyncswap/eth-types";
+// engine types
+export interface TransitionConfigurationV1 {
+	terminalTotalDifficulty: Uint256;
+	terminalBlockHash: Hash32;
+	terminalBlockNumber: Uint64;
+}

package/CHANGELOG.md

@@ -1,57 +0,0 @@
-# @asyncswap/engine-rpc
-
-## 0.0.7
-
-### Patch Changes
-
-- 2f7dece: fixes build
-- Updated dependencies [2f7dece]
-  - @asyncswap/jsonrpc@0.4.11
-
-## 0.0.6
-
-### Patch Changes
-
-- 69a2d7e: patch types updates
-- Updated dependencies [69a2d7e]
-  - @asyncswap/jsonrpc@0.4.10
-
-## 0.0.5
-
-### Patch Changes
-
-- dc792b1: (refactor): change to `withHeaders` option and update BaseClient source
-- Updated dependencies [dc792b1]
-  - @asyncswap/jsonrpc@0.4.9
-
-## 0.0.4
-
-### Patch Changes
-
-- e9fc1df: remove biome dep
-- Updated dependencies [e9fc1df]
-  - @asyncswap/eth-rpc@0.4.9
-
-## 0.0.3
-
-### Patch Changes
-
-- 494a28f: update package location
-
-## 0.0.2
-
-### Patch Changes
-
-- 863d9b8: udpate example
-
-## 0.0.1
-
-### Patch Changes
-
-- 97a6143: engine rpc spec
-
-  - Adds class for engine api spec
-  - Add example and docs
-
-- Updated dependencies [cad9042]
-  - @asyncswap/eth-rpc@0.4.8

package/example.ts

@@ -1,6 +0,0 @@
-import { EngineExecutionClient } from "./src";
-
-const engineUrl = "http://localhost:8551";
-const engine = new EngineExecutionClient(engineUrl, process.env.JWT_TOKEN!);
-const payload = await engine.eth_chainId();
-console.log(payload);

package/src/types/blob.d.ts

@@ -1,12 +0,0 @@
-declare global {
-	export interface BlobAndProofV1 {
-		blob: Bytes;
-		proof: Bytes48;
-	}
-	export interface BlobAndProofV2 {
-		blob: Bytes;
-		proofs: Bytes48[];
-	}
-}
-
-export { };

package/src/types/forkchoice.d.ts

@@ -1,32 +0,0 @@
-declare global {
-	// forkchoice
-	export interface ForkchoiceStateV1 {
-		headBlockHash: Hash32;
-		safeBlockHash: Hash32;
-		finalizedBlockHash: Hash32;
-	}
-	export interface ForkchoiceUpdatedResponseV1 {
-		payloadStatus: RestrictedPayloadStatusV1;
-		payloadId?: Bytes8;
-	}
-	export interface PayloadAttributesV1 {
-		timestamp: Uint64;
-		prevRandao: Bytes32;
-		suggestedFeeRecipient: Address;
-	}
-	export interface PayloadAttributesV2 {
-		timestamp: Uint64;
-		prevRandao: Bytes32;
-		suggestedFeeRecipient: Address;
-		withdrawals: WithdrawalV1[];
-	}
-	export interface PayloadAttributesV3 {
-		timestamp: Uint64;
-		prevRandao: Bytes32;
-		suggestedFeeRecipient: Address;
-		withdrawals: WithdrawalV1[];
-		parentBeaconBlockRoot: Hash32;
-	}
-}
-
-export { };

package/src/types/identification.d.ts

@@ -1,24 +0,0 @@
-declare global {
-	export type ClientVersionV1 = {
-		code: ClientCode;
-		name: string;
-		varsion: string;
-		commit: string;
-	};
-	export type ClientCode =
-		| "BU" // besu
-		| "EJ" // ethereumJs
-		| "EG" // erigon
-		| "GE" // go-ethereum
-		| "GR" // gradine
-		| "LH" // lighthouse
-		| "LS" // lodestar
-		| "NM" // nethermind
-		| "NB" // nimbus
-		| "TE" // thin-execution
-		| "TK" // teku
-		| "PM" // prysm
-		| "RH"; // reth
-}
-
-export { };

package/src/types/methods.d.ts

@@ -1,130 +0,0 @@
-declare global {
-	export type EngineMethodsSpec = {
-		// identification
-		engine_getClientVersionV1: {
-			params: [ClientVersionV1];
-			result: ClientVersionV1[];
-		};
-		// share methods
-		eth_blockNumber: { params: []; result: Uint };
-		eth_call: {
-			params: [GenericTransaction, BlockNumberOrTagOrHash];
-			result: Bytes;
-		};
-		eth_chainId: { params: []; result: Uint };
-		eth_getCode: { params: [Address, BlockNumberOrTagOrHash]; result: Bytes };
-		eth_getBlockByHash: { params: [Hash32, boolean]; result: NotFound | Block };
-		eth_getBlockByNumber: {
-			params: [BlockNumberOrTag, boolean];
-			result: NotFound | Block;
-		};
-		eth_getLogs: { params: [Filter]; result: FilterResults };
-		eth_sendRawTransaction: { params: [Bytes]; result: Hash32 };
-		eth_syncing: { params: []; result: SyncingStatus };
-		// engine/blob
-		engine_getBlobsV1: { params: [Hash32[]]; result: BlobAndProofV1[] };
-		engine_getBlobsV2: { params: [Hash32[]]; result: BlobAndProofV2[] };
-		engine_getBlobsV3: {
-			params: [Hash32[]];
-			result: Array<BlobAndProofV2[] | null> | null;
-		};
-		// engine/capabilities
-		engine_exchangeCapabilities: { params: [string[]]; result: string[] };
-		// engine/forkchoice
-		engine_forkchoiceUpdatedV1: {
-			params: [ForkchoiceStateV1, PayloadAttributesV1];
-			result: ForkchoiceUpdatedResponseV1;
-		};
-		engine_forkchoiceUpdatedV2: {
-			params: [ForkchoiceStateV1, PayloadAttributesV2];
-			result: ForkchoiceUpdatedResponseV1;
-		};
-		engine_forkchoiceUpdatedV3: {
-			params: [ForkchoiceStateV1, PayloadAttributesV3];
-			result: ForkchoiceUpdatedResponseV1;
-		};
-		// engine/payload
-		engine_newPayloadV1: {
-			params: [ExecutionPayloadV1];
-			result: PayloadStatusV1;
-		};
-		engine_newPayloadV2: {
-			params: [ExecutionPayloadV1 | ExecutionPayloadV2];
-			result: PayloadStatusNoInvalidBlockHash;
-		};
-		engine_newPayloadV3: {
-			params: [ExecutionPayloadV3, Hash32[], Hash32];
-			result: PayloadStatusNoInvalidBlockHash;
-		};
-		engine_newPayloadV4: {
-			params: [ExecutionPayloadV3, Hash32[], Hash32, Bytes[]];
-			result: PayloadStatusNoInvalidBlockHash;
-		};
-		engine_getPayloadV1: { params: [Bytes8]; result: ExecutionPayloadV1 };
-		engine_getPayloadV2: {
-			params: [Bytes8];
-			result: {
-				executionPayload: ExecutionPayloadV1 | ExecutionPayloadV2;
-				blockValue: Uint256;
-			};
-		};
-		engine_getPayloadV3: {
-			params: [Bytes8];
-			result: {
-				executionPayload: ExecutionPayloadV3;
-				blockValue: Uint256;
-				blobsBundle: BlobsBundleV1;
-				shouldOverrideBuilder: boolean;
-			};
-		};
-		engine_getPayloadV4: {
-			params: [Bytes8];
-			result: {
-				executionPayload: ExecutionPayloadV3;
-				blockValue: Uint256;
-				blobsBundle: BlobsBundleV1;
-				shouldOverrideBuilder: boolean;
-				executionRequests: Bytes[];
-			};
-		};
-		engine_getPayloadV5: {
-			params: [Bytes8];
-			result: {
-				executionPayload: ExecutionPayloadV3;
-				blockValue: Uint256;
-				blobsBundle: BlobsBundleV2;
-				shouldOverrideBuilder: boolean;
-				executionRequests: Bytes[];
-			};
-		};
-		engine_getPayloadBodiesByHashV1: {
-			params: [Hash32[]];
-			result: ExecutionPayloadBodyV1[];
-		};
-		engine_getPayloadBodiesByRangeV1: {
-			params: [Uint64, Uint64];
-			result: ExecutionPayloadBodyV1[];
-		};
-		engine_newPayloadV5: {
-			params: [ExecutionPayloadV4, Hash32[], Hash32, Bytes[]];
-			result: PayloadStatusNoInvalidBlockHash;
-		};
-		engine_getPayloadV6: {
-			params: [Bytes8];
-			result: {
-				executionPayload: ExecutionPayloadV4;
-				blockValue: Uint256;
-				blobsBundle: BlobsBundleV2;
-				shouldOverrideBuilder: boolean;
-				executionRequests: Bytes[];
-			};
-		};
-		// engine/transition-configuration
-		engine_exchangeTransitionConfigurationV1: {
-			params: [TransitionConfigurationV1];
-			result: TransitionConfigurationV1;
-		};
-	};
-}
-
-export { };

package/src/types/payload.d.ts

@@ -1,121 +0,0 @@
-declare global {
-	export enum PAYLOAD_STATUS {
-		VALID = "VALID",
-		INVALID = "INVALID",
-		SYNCING = "SYNCING",
-		ACCEPTED = "ACCEPTED",
-		INVALID_BLOCK_HASH = "INVALID_BLOCK_HASH",
-	}
-	export interface PayloadStatusV1 {
-		status: PAYLOAD_STATUS;
-		latestValidHash?: Hash32;
-		validationError?: string;
-	}
-	export interface RestrictedPayloadStatusV1 {
-		status:
-		| PAYLOAD_STATUS.VALID
-		| PAYLOAD_STATUS.INVALID
-		| PAYLOAD_STATUS.SYNCING;
-		latestValidHash: Hash32;
-		validationError: string;
-	}
-	export interface PayloadStatusNoInvalidBlockHash {
-		status: Exclude<PAYLOAD_STATUS, PAYLOAD_STATUS.INVALID_BLOCK_HASH>;
-		latestValidHash: Hash32;
-		validationError: string;
-	}
-	export interface ExecutionPayloadV1 {
-		parentHash: Hash32;
-		feeRecipient: Address;
-		stateRoot: Bytes32;
-		receiptsRoot: Bytes32;
-		logsBloom: Bytes256;
-		prevRandao: Bytes32;
-		blockNumber: Uint64;
-		gasLimit: Uint64;
-		gasUsed: Uint64;
-		timestamp: Uint64;
-		extraData: Bytes32;
-		baseFeePerGas: Uint64;
-		blockHash: Hash32;
-		transactions: Bytes[];
-	}
-	export interface WithdrawalV1 {
-		index: Uint64;
-		validatorIndex: Uint64;
-		address: Address;
-		amount: Uint64;
-	}
-	export interface ExecutionPayloadV2 {
-		parentHash: Hash32;
-		feeRecipient: Address;
-		stateRoot: Bytes32;
-		receiptsRoot: Bytes32;
-		logsBloom: Bytes256;
-		prevRandao: Bytes32;
-		blockNumber: Uint64;
-		gasLimit: Uint64;
-		gasUsed: Uint64;
-		timestamp: Uint64;
-		extraData: Bytes32;
-		baseFeePerGas: Uint64;
-		blockHash: Hash32;
-		transactions: Bytes[];
-		withdrawals: WithdrawalV1[];
-	}
-	export interface ExecutionPayloadV3 {
-		parentHash: Hash32;
-		feeRecipient: Address;
-		stateRoot: Bytes32;
-		receiptsRoot: Bytes32;
-		logsBloom: Bytes256;
-		prevRandao: Bytes32;
-		blockNumber: Uint64;
-		gasLimit: Uint64;
-		gasUsed: Uint64;
-		timestamp: Uint64;
-		extraData: Bytes32;
-		baseFeePerGas: Uint64;
-		blockHash: Hash32;
-		transactions: Bytes[];
-		withdrawals: WithdrawalV1[];
-		blobGasUsed: Uint64;
-		excessBlobGas: Uint64;
-	}
-	export interface ExecutionPayloadV4 {
-		parentHash: Hash32;
-		feeRecipient: Address;
-		stateRoot: Bytes32;
-		receiptsRoot: Bytes32;
-		logsBloom: Bytes256;
-		prevRandao: Bytes32;
-		blockNumber: Uint64;
-		gasLimit: Uint64;
-		gasUsed: Uint64;
-		timestamp: Uint64;
-		extraData: Bytes32;
-		baseFeePerGas: Uint64;
-		blockHash: Hash32;
-		transactions: Bytes[];
-		withdrawals: WithdrawalV1[];
-		blobGasUsed: Uint64;
-		excessBlobGas: Uint64;
-		blockAccessList: Bytes;
-	}
-	export interface ExecutionPayloadBodyV1 {
-		transactions: Bytes[];
-		withdrawals?: WithdrawalV1[];
-	}
-	export interface BlobsBundleV1 {
-		commitments: Bytes48[];
-		proofs: Bytes48[];
-		blobs: Bytes[];
-	}
-	export interface BlobsBundleV2 {
-		commitments: Bytes48[];
-		proofs: Bytes48[];
-		blobs: Bytes[];
-	}
-}
-
-export { };

package/src/types/transition-configuration.d.ts

@@ -1,10 +0,0 @@
-declare global {
-	// engine types
-	export interface TransitionConfigurationV1 {
-		terminalTotalDifficulty: Uint256;
-		terminalBlockHash: Hash32;
-		terminalBlockNumber: Uint64;
-	}
-}
-
-export { };