web3-types - npm Package Compare versions

Comparing version 1.0.3-dev.ad377d1.0 to 1.0.3-dev.b771112.0

lib/commonjs/apis/web3_eth_execution_api.d.ts

 import { EthExecutionAPI } from './eth_execution_api.js';
-import { AccountObject, Address, BlockNumberOrTag, HexString32Bytes, TransactionInfo, Uint } from '../eth_types.js';
+import { AccountObject, Address, BlockNumberOrTag, Eip712TypedData, HexString256Bytes, HexString32Bytes, TransactionInfo, Uint } from '../eth_types.js';
 export declare type Web3EthExecutionAPI = EthExecutionAPI & {
@@ -9,2 +9,4 @@ eth_pendingTransactions: () => TransactionInfo[];
     eth_getProof: (address: Address, storageKeys: HexString32Bytes[], blockNumber: BlockNumberOrTag) => AccountObject;
+    eth_signTypedData: (address: Address, typedData: Eip712TypedData, useLegacy: true) => HexString256Bytes;
+    eth_signTypedData_v4: (address: Address, typedData: Eip712TypedData, useLegacy: false | undefined) => HexString256Bytes;
 };

lib/commonjs/eth_types.d.ts

@@ -115,14 +115,34 @@ import { Bytes, HexString, Numbers } from './primitives_types.js';
 }
+export interface Withdrawals {
+    readonly index: Numbers;
+    readonly validatorIndex: Numbers;
+    readonly address: Address;
+    readonly amount: Numbers;
+}
 export interface BlockHeaderOutput {
+    readonly hash?: HexString32Bytes;
+    readonly parentHash?: HexString32Bytes;
+    readonly receiptsRoot?: HexString32Bytes;
+    readonly miner?: HexString;
+    readonly stateRoot?: HexString32Bytes;
+    readonly transactionsRoot?: HexString32Bytes;
+    readonly withdrawalsRoot?: HexString32Bytes;
+    readonly logsBloom?: Bytes;
+    readonly difficulty?: Numbers;
+    readonly number?: Numbers;
     readonly gasLimit: Numbers;
     readonly gasUsed: Numbers;
     readonly timestamp: Numbers;
-    readonly number?: Numbers;
-    readonly difficulty?: Numbers;
+    readonly extraData?: Bytes;
+    readonly nonce?: Numbers;
+    readonly sha3Uncles: HexString32Bytes[];
+    readonly baseFeePerGas?: Numbers;
+    readonly author?: Address;
     readonly totalDifficulty?: Numbers;
+    readonly size?: Numbers;
+    readonly excessDataGas?: Numbers;
+    readonly mixHash?: HexString32Bytes;
     readonly transactions?: TransactionOutput[];
-    readonly miner?: HexString;
-    readonly baseFeePerGas?: Numbers;
-    readonly parentHash?: HexString32Bytes;
-    readonly sha3Uncles: HexString32Bytes[];
+    readonly uncles?: Uncles;
+    readonly withdrawals?: Withdrawals[];
 }
@@ -386,2 +406,15 @@ export interface ReceiptInput {
 }
+export interface Eip712TypeDetails {
+    name: string;
+    type: string;
+}
+export interface Eip712TypedData {
+    readonly types: {
+        EIP712Domain: Eip712TypeDetails[];
+        [key: string]: Eip712TypeDetails[];
+    };
+    readonly primaryType: string;
+    readonly domain: Record<string, string | number>;
+    readonly message: Record<string, unknown>;
+}
 export {};

lib/types/apis/web3_eth_execution_api.d.ts

 import { EthExecutionAPI } from './eth_execution_api.js';
-import { AccountObject, Address, BlockNumberOrTag, HexString32Bytes, TransactionInfo, Uint } from '../eth_types.js';
+import { AccountObject, Address, BlockNumberOrTag, Eip712TypedData, HexString256Bytes, HexString32Bytes, TransactionInfo, Uint } from '../eth_types.js';
 export declare type Web3EthExecutionAPI = EthExecutionAPI & {
@@ -9,3 +9,5 @@ eth_pendingTransactions: () => TransactionInfo[];
     eth_getProof: (address: Address, storageKeys: HexString32Bytes[], blockNumber: BlockNumberOrTag) => AccountObject;
+    eth_signTypedData: (address: Address, typedData: Eip712TypedData, useLegacy: true) => HexString256Bytes;
+    eth_signTypedData_v4: (address: Address, typedData: Eip712TypedData, useLegacy: false | undefined) => HexString256Bytes;
 };
 //# sourceMappingURL=web3_eth_execution_api.d.ts.map

lib/types/eth_types.d.ts

@@ -115,14 +115,34 @@ import { Bytes, HexString, Numbers } from './primitives_types.js';
 }
+export interface Withdrawals {
+    readonly index: Numbers;
+    readonly validatorIndex: Numbers;
+    readonly address: Address;
+    readonly amount: Numbers;
+}
 export interface BlockHeaderOutput {
+    readonly hash?: HexString32Bytes;
+    readonly parentHash?: HexString32Bytes;
+    readonly receiptsRoot?: HexString32Bytes;
+    readonly miner?: HexString;
+    readonly stateRoot?: HexString32Bytes;
+    readonly transactionsRoot?: HexString32Bytes;
+    readonly withdrawalsRoot?: HexString32Bytes;
+    readonly logsBloom?: Bytes;
+    readonly difficulty?: Numbers;
+    readonly number?: Numbers;
     readonly gasLimit: Numbers;
     readonly gasUsed: Numbers;
     readonly timestamp: Numbers;
-    readonly number?: Numbers;
-    readonly difficulty?: Numbers;
+    readonly extraData?: Bytes;
+    readonly nonce?: Numbers;
+    readonly sha3Uncles: HexString32Bytes[];
+    readonly baseFeePerGas?: Numbers;
+    readonly author?: Address;
     readonly totalDifficulty?: Numbers;
+    readonly size?: Numbers;
+    readonly excessDataGas?: Numbers;
+    readonly mixHash?: HexString32Bytes;
     readonly transactions?: TransactionOutput[];
-    readonly miner?: HexString;
-    readonly baseFeePerGas?: Numbers;
-    readonly parentHash?: HexString32Bytes;
-    readonly sha3Uncles: HexString32Bytes[];
+    readonly uncles?: Uncles;
+    readonly withdrawals?: Withdrawals[];
 }
@@ -386,3 +406,16 @@ export interface ReceiptInput {
 }
+export interface Eip712TypeDetails {
+    name: string;
+    type: string;
+}
+export interface Eip712TypedData {
+    readonly types: {
+        EIP712Domain: Eip712TypeDetails[];
+        [key: string]: Eip712TypeDetails[];
+    };
+    readonly primaryType: string;
+    readonly domain: Record<string, string | number>;
+    readonly message: Record<string, unknown>;
+}
 export {};
 //# sourceMappingURL=eth_types.d.ts.map

package.json

 {
 	"name": "web3-types",
-	"version": "1.0.3-dev.ad377d1.0+ad377d1",
+	"version": "1.0.3-dev.b771112.0+b771112",
 	"description": "Provide the common data structures and interfaces for web3 modules.",
@@ -59,3 +59,3 @@ "main": "./lib/commonjs/index.js",
 	},
-	"gitHead": "ad377d16a7e9a8e82857d6102bb4efd95c543e4f"
+	"gitHead": "b77111264dbdacf34d0c9ebe803efddf372ce3f1"
 }

src/apis/web3_eth_execution_api.ts

@@ -22,2 +22,4 @@ /*
 	BlockNumberOrTag,
+	Eip712TypedData,
+	HexString256Bytes,
 	HexString32Bytes,
@@ -45,2 +47,16 @@ TransactionInfo,
 	) => AccountObject;
+
+	// https://github.com/ethereum/EIPs/blob/master/EIPS/eip-712.md
+	eth_signTypedData: (
+		address: Address,
+		typedData: Eip712TypedData,
+		useLegacy: true,
+	) => HexString256Bytes;
+
+	// https://github.com/ethereum/EIPs/blob/master/EIPS/eip-712.md
+	eth_signTypedData_v4: (
+		address: Address,
+		typedData: Eip712TypedData,
+		useLegacy: false | undefined,
+	) => HexString256Bytes;
 };

src/eth_types.ts

@@ -147,14 +147,38 @@ /*
 
+export interface Withdrawals {
+	readonly index: Numbers;
+	readonly validatorIndex: Numbers;
+	readonly address: Address;
+	readonly amount: Numbers;
+}
+
 export interface BlockHeaderOutput {
+	readonly hash?: HexString32Bytes;
+	readonly parentHash?: HexString32Bytes;
+	readonly receiptsRoot?: HexString32Bytes;
+	readonly miner?: HexString;
+	readonly stateRoot?: HexString32Bytes;
+	readonly transactionsRoot?: HexString32Bytes;
+	readonly withdrawalsRoot?: HexString32Bytes;
+	readonly logsBloom?: Bytes;
+	readonly difficulty?: Numbers;
+	readonly number?: Numbers;
 	readonly gasLimit: Numbers;
 	readonly gasUsed: Numbers;
 	readonly timestamp: Numbers;
-	readonly number?: Numbers;
-	readonly difficulty?: Numbers;
+	readonly extraData?: Bytes;
+	readonly nonce?: Numbers;
+	readonly sha3Uncles: HexString32Bytes[];
+	readonly baseFeePerGas?: Numbers;
+
+	// These fields are returned when the RPC client is Nethermind,
+	// but aren't available in other clients such as Geth
+	readonly author?: Address;
 	readonly totalDifficulty?: Numbers;
+	readonly size?: Numbers;
+	readonly excessDataGas?: Numbers;
+	readonly mixHash?: HexString32Bytes;
 	readonly transactions?: TransactionOutput[];
-	readonly miner?: HexString;
-	readonly baseFeePerGas?: Numbers;
-	readonly parentHash?: HexString32Bytes;
-	readonly sha3Uncles: HexString32Bytes[];
+	readonly uncles?: Uncles;
+	readonly withdrawals?: Withdrawals[];
 }
@@ -476,1 +500,15 @@
 }
+
+export interface Eip712TypeDetails {
+	name: string;
+	type: string;
+}
+export interface Eip712TypedData {
+	readonly types: {
+		EIP712Domain: Eip712TypeDetails[];
+		[key: string]: Eip712TypeDetails[];
+	};
+	readonly primaryType: string;
+	readonly domain: Record<string, string | number>;
+	readonly message: Record<string, unknown>;
+}

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

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

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

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

263692

increased by2.15%

Lines of code

4779

increased by2.55%

No dependency changes