web3-eth - npm Package Compare versions

Comparing version 4.8.3-dev.f87ffbe.0 to 4.9.0

lib/commonjs/rpc_method_wrappers.js

@@ -276,2 +276,3 @@ "use strict";
             : (0, format_transaction_js_1.formatTransaction)(response, returnFormat, {
+                transactionSchema: web3Context.config.customTransactionSchema,
                 fillInputAndData: true,
@@ -290,2 +291,3 @@ });
         return response.map(transaction => (0, format_transaction_js_1.formatTransaction)(transaction, returnFormat !== null && returnFormat !== void 0 ? returnFormat : web3Context.defaultReturnFormat, {
+            transactionSchema: web3Context.config.customTransactionSchema,
             fillInputAndData: true,
@@ -317,2 +319,3 @@ }));
             : (0, format_transaction_js_1.formatTransaction)(response, returnFormat !== null && returnFormat !== void 0 ? returnFormat : web3Context.defaultReturnFormat, {
+                transactionSchema: web3Context.config.customTransactionSchema,
                 fillInputAndData: true,
@@ -336,3 +339,6 @@ });
             // geth indexing error, we poll until transactions stopped indexing
-            if (typeof error === 'object' && !(0, web3_validator_1.isNullish)(error) && 'message' in error && error.message === 'transaction indexing is in progress') {
+            if (typeof error === 'object' &&
+                !(0, web3_validator_1.isNullish)(error) &&
+                'message' in error &&
+                error.message === 'transaction indexing is in progress') {
                 console.warn('Transaction indexing is in progress.');
@@ -346,3 +352,3 @@ }
             ? response
-            : ((0, web3_utils_1.format)(schemas_js_1.transactionReceiptSchema, response, returnFormat !== null && returnFormat !== void 0 ? returnFormat : web3Context.defaultReturnFormat));
+            : (0, web3_utils_1.format)(schemas_js_1.transactionReceiptSchema, response, returnFormat !== null && returnFormat !== void 0 ? returnFormat : web3Context.defaultReturnFormat);
     });
@@ -383,3 +389,5 @@ }
                 }
-                let transactionFormatted = (0, format_transaction_js_1.formatTransaction)(Object.assign(Object.assign({}, transaction), { from: (0, transaction_builder_js_1.getTransactionFromOrToAttr)('from', web3Context, transaction), to: (0, transaction_builder_js_1.getTransactionFromOrToAttr)('to', web3Context, transaction) }), web3_types_1.ETH_DATA_FORMAT);
+                let transactionFormatted = (0, format_transaction_js_1.formatTransaction)(Object.assign(Object.assign({}, transaction), { from: (0, transaction_builder_js_1.getTransactionFromOrToAttr)('from', web3Context, transaction), to: (0, transaction_builder_js_1.getTransactionFromOrToAttr)('to', web3Context, transaction) }), web3_types_1.ETH_DATA_FORMAT, {
+                    transactionSchema: web3Context.config.customTransactionSchema,
+                });
                 try {
@@ -514,3 +522,5 @@ transactionFormatted = yield sendTxHelper.populateGasPrice({
     return __awaiter(this, void 0, void 0, function* () {
-        const response = yield web3_rpc_methods_1.ethRpcMethods.signTransaction(web3Context.requestManager, (0, format_transaction_js_1.formatTransaction)(transaction, web3_types_1.ETH_DATA_FORMAT));
+        const response = yield web3_rpc_methods_1.ethRpcMethods.signTransaction(web3Context.requestManager, (0, format_transaction_js_1.formatTransaction)(transaction, web3_types_1.ETH_DATA_FORMAT, {
+            transactionSchema: web3Context.config.customTransactionSchema,
+        }));
         // Some clients only return the encoded signed transaction (e.g. Ganache)
@@ -525,2 +535,3 @@ // while clients such as Geth return the desired SignedTransactionInfoAPI object
                 tx: (0, format_transaction_js_1.formatTransaction)(response.tx, returnFormat, {
+                    transactionSchema: web3Context.config.customTransactionSchema,
                     fillInputAndData: true,
@@ -543,3 +554,5 @@ }),
             : (0, web3_utils_1.format)({ format: 'uint' }, blockNumber, web3_types_1.ETH_DATA_FORMAT);
-        const response = yield web3_rpc_methods_1.ethRpcMethods.call(web3Context.requestManager, (0, format_transaction_js_1.formatTransaction)(transaction, web3_types_1.ETH_DATA_FORMAT), blockNumberFormatted);
+        const response = yield web3_rpc_methods_1.ethRpcMethods.call(web3Context.requestManager, (0, format_transaction_js_1.formatTransaction)(transaction, web3_types_1.ETH_DATA_FORMAT, {
+            transactionSchema: web3Context.config.customTransactionSchema,
+        }), blockNumberFormatted);
         return (0, web3_utils_1.format)({ format: 'bytes' }, response, returnFormat);
@@ -556,3 +569,5 @@ });
     return __awaiter(this, void 0, void 0, function* () {
-        const transactionFormatted = (0, format_transaction_js_1.formatTransaction)(transaction, web3_types_1.ETH_DATA_FORMAT);
+        const transactionFormatted = (0, format_transaction_js_1.formatTransaction)(transaction, web3_types_1.ETH_DATA_FORMAT, {
+            transactionSchema: web3Context.config.customTransactionSchema,
+        });
         const blockNumberFormatted = (0, web3_validator_1.isBlockTag)(blockNumber)
@@ -657,3 +672,5 @@ ? blockNumber
             : (0, web3_utils_1.format)({ format: 'uint' }, blockNumber, web3_types_1.ETH_DATA_FORMAT);
-        const response = (yield web3_rpc_methods_1.ethRpcMethods.createAccessList(web3Context.requestManager, (0, format_transaction_js_1.formatTransaction)(transaction, web3_types_1.ETH_DATA_FORMAT), blockNumberFormatted));
+        const response = (yield web3_rpc_methods_1.ethRpcMethods.createAccessList(web3Context.requestManager, (0, format_transaction_js_1.formatTransaction)(transaction, web3_types_1.ETH_DATA_FORMAT, {
+            transactionSchema: web3Context.config.customTransactionSchema,
+        }), blockNumberFormatted));
         return (0, web3_utils_1.format)(schemas_js_1.accessListResultSchema, response, returnFormat !== null && returnFormat !== void 0 ? returnFormat : web3Context.defaultReturnFormat);
@@ -660,0 +677,0 @@ });

lib/commonjs/types.d.ts

 import { ContractExecutionError, TransactionRevertedWithoutReasonError, TransactionRevertInstructionError, TransactionRevertWithCustomError, InvalidResponseError, TransactionPollingTimeoutError } from 'web3-errors';
 import { FormatType, ETH_DATA_FORMAT, DataFormat, Bytes, ContractAbi, HexString, Numbers, Transaction, TransactionReceipt, TransactionWithFromAndToLocalWalletIndex, TransactionWithFromLocalWalletIndex, TransactionWithToLocalWalletIndex } from 'web3-types';
+import { Schema } from 'web3-validator';
 export declare type InternalTransaction = FormatType<Transaction, typeof ETH_DATA_FORMAT>;
@@ -46,1 +47,5 @@ export declare type SendTransactionEventsBase<ReturnFormat extends DataFormat, TxType> = {
 }
+export declare type CustomTransactionSchema = {
+    type: string;
+    properties: Record<string, Schema>;
+};

lib/commonjs/utils/decode_signed_transaction.d.ts

 import { DataFormat, HexStringBytes, SignedTransactionInfoAPI } from 'web3-types';
+import { type CustomTransactionSchema } from '../types.js';
 /**
@@ -11,2 +12,3 @@ * Decodes an [RLP](https://ethereum.org/en/developers/docs/data-structures-and-encoding/rlp/#top) encoded transaction.
     fillInputAndData?: boolean;
+    transactionSchema?: CustomTransactionSchema;
 }): SignedTransactionInfoAPI;

lib/commonjs/utils/decode_signed_transaction.js

@@ -15,6 +15,11 @@ "use strict";
  */
-function decodeSignedTransaction(encodedSignedTransaction, returnFormat, options = { fillInputAndData: false }) {
+function decodeSignedTransaction(encodedSignedTransaction, returnFormat, options = {
+    fillInputAndData: false,
+}) {
     return {
         raw: (0, web3_utils_1.format)({ format: 'bytes' }, encodedSignedTransaction, returnFormat),
-        tx: (0, format_transaction_js_1.formatTransaction)(Object.assign(Object.assign({}, web3_eth_accounts_1.TransactionFactory.fromSerializedData((0, web3_utils_1.hexToBytes)(encodedSignedTransaction)).toJSON()), { hash: (0, web3_utils_1.bytesToHex)((0, web3_utils_1.keccak256)((0, web3_utils_1.hexToBytes)(encodedSignedTransaction))), type: (0, detect_transaction_type_js_1.detectRawTransactionType)((0, web3_utils_1.hexToBytes)(encodedSignedTransaction)) }), returnFormat, { fillInputAndData: options.fillInputAndData }),
+        tx: (0, format_transaction_js_1.formatTransaction)(Object.assign(Object.assign({}, web3_eth_accounts_1.TransactionFactory.fromSerializedData((0, web3_utils_1.hexToBytes)(encodedSignedTransaction)).toJSON()), { hash: (0, web3_utils_1.bytesToHex)((0, web3_utils_1.keccak256)((0, web3_utils_1.hexToBytes)(encodedSignedTransaction))), type: (0, detect_transaction_type_js_1.detectRawTransactionType)((0, web3_utils_1.hexToBytes)(encodedSignedTransaction)) }), returnFormat, {
+            fillInputAndData: options.fillInputAndData,
+            transactionSchema: options.transactionSchema,
+        }),
     };
@@ -21,0 +26,0 @@ }

lib/commonjs/utils/detect_transaction_type.js

@@ -70,3 +70,3 @@ "use strict";
 };
-const defaultTransactionTypeParser = (transaction) => {
+const defaultTransactionTypeParser = transaction => {
     var _a, _b;
@@ -73,0 +73,0 @@ const tx = transaction;

lib/commonjs/utils/format_transaction.d.ts

 import { Transaction, DataFormat, DEFAULT_RETURN_FORMAT, FormatType } from 'web3-types';
 import { ValidationSchemaInput } from 'web3-validator';
-import { transactionSchema } from '../schemas.js';
+import { type CustomTransactionSchema } from '../types.js';
 export declare function formatTransaction<ReturnFormat extends DataFormat = typeof DEFAULT_RETURN_FORMAT, TransactionType extends Transaction = Transaction>(transaction: TransactionType, returnFormat?: ReturnFormat, options?: {
-    transactionSchema?: ValidationSchemaInput | typeof transactionSchema;
+    transactionSchema?: ValidationSchemaInput | CustomTransactionSchema | undefined;
     fillInputAndData?: boolean;
 }): FormatType<TransactionType, ReturnFormat>;

lib/commonjs/utils/prepare_transaction_for_signing.js

@@ -106,4 +106,8 @@ "use strict";
     }));
-    const formattedTransaction = (0, format_transaction_js_1.formatTransaction)(populatedTransaction, web3_types_1.ETH_DATA_FORMAT);
-    (0, validation_js_1.validateTransactionForSigning)(formattedTransaction);
+    const formattedTransaction = (0, format_transaction_js_1.formatTransaction)(populatedTransaction, web3_types_1.ETH_DATA_FORMAT, {
+        transactionSchema: web3Context.config.customTransactionSchema,
+    });
+    (0, validation_js_1.validateTransactionForSigning)(formattedTransaction, undefined, {
+        transactionSchema: web3Context.config.customTransactionSchema,
+    });
     return web3_eth_accounts_1.TransactionFactory.fromTxData(getEthereumjsTxDataFromTransaction(formattedTransaction), getEthereumjsTransactionOptions(formattedTransaction, web3Context));
@@ -110,0 +114,0 @@ });

lib/commonjs/utils/send_tx_helper.js

@@ -73,3 +73,4 @@ "use strict";
                 let formatTx = tx;
-                if ((0, web3_validator_1.isNullish)(tx.data) && (0, web3_validator_1.isNullish)(tx.input) && (0, web3_validator_1.isNullish)(tx.gas)) { // eth.call runs into error if data isnt filled and gas is not defined, its a simple transaction so we fill it with 21000
+                if ((0, web3_validator_1.isNullish)(tx.data) && (0, web3_validator_1.isNullish)(tx.input) && (0, web3_validator_1.isNullish)(tx.gas)) {
+                    // eth.call runs into error if data isnt filled and gas is not defined, its a simple transaction so we fill it with 21000
                     formatTx = Object.assign(Object.assign({}, tx), { gas: 21000 });
@@ -76,0 +77,0 @@ }

lib/commonjs/validation.d.ts

 import { AccessList, AccessListEntry, BaseTransactionAPI, Transaction1559UnsignedAPI, Transaction2930UnsignedAPI, TransactionCall, TransactionLegacyUnsignedAPI, TransactionWithSenderAPI } from 'web3-types';
-import { InternalTransaction } from './types.js';
+import { CustomTransactionSchema, InternalTransaction } from './types.js';
 export declare function isBaseTransaction(value: BaseTransactionAPI): boolean;
@@ -24,2 +24,4 @@ export declare function isAccessListEntry(value: AccessListEntry): boolean;
 export declare const validateGas: (transaction: InternalTransaction) => void;
-export declare const validateTransactionForSigning: (transaction: InternalTransaction, overrideMethod?: ((transaction: InternalTransaction) => void) | undefined) => void;
+export declare const validateTransactionForSigning: (transaction: InternalTransaction, overrideMethod?: ((transaction: InternalTransaction) => void) | undefined, options?: {
+    transactionSchema?: CustomTransactionSchema;
+}) => void;

lib/commonjs/validation.js

@@ -256,3 +256,3 @@ "use strict";
 exports.validateGas = validateGas;
-const validateTransactionForSigning = (transaction, overrideMethod) => {
+const validateTransactionForSigning = (transaction, overrideMethod, options = { transactionSchema: undefined }) => {
     if (!(0, web3_validator_1.isNullish)(overrideMethod)) {
@@ -268,3 +268,5 @@ overrideMethod(transaction);
     (0, exports.validateHardfork)(transaction);
-    const formattedTransaction = (0, format_transaction_js_1.formatTransaction)(transaction, web3_types_1.ETH_DATA_FORMAT);
+    const formattedTransaction = (0, format_transaction_js_1.formatTransaction)(transaction, web3_types_1.ETH_DATA_FORMAT, {
+        transactionSchema: options.transactionSchema,
+    });
     (0, exports.validateGas)(formattedTransaction);
@@ -271,0 +273,0 @@ if ((0, web3_validator_1.isNullish)(formattedTransaction.nonce) ||

lib/esm/rpc_method_wrappers.js

@@ -258,2 +258,3 @@ /*
             : formatTransaction(response, returnFormat, {
+                transactionSchema: web3Context.config.customTransactionSchema,
                 fillInputAndData: true,
@@ -271,2 +272,3 @@ });
         return response.map(transaction => formatTransaction(transaction, returnFormat !== null && returnFormat !== void 0 ? returnFormat : web3Context.defaultReturnFormat, {
+            transactionSchema: web3Context.config.customTransactionSchema,
             fillInputAndData: true,
@@ -297,2 +299,3 @@ }));
             : formatTransaction(response, returnFormat !== null && returnFormat !== void 0 ? returnFormat : web3Context.defaultReturnFormat, {
+                transactionSchema: web3Context.config.customTransactionSchema,
                 fillInputAndData: true,
@@ -315,3 +318,6 @@ });
             // geth indexing error, we poll until transactions stopped indexing
-            if (typeof error === 'object' && !isNullish(error) && 'message' in error && error.message === 'transaction indexing is in progress') {
+            if (typeof error === 'object' &&
+                !isNullish(error) &&
+                'message' in error &&
+                error.message === 'transaction indexing is in progress') {
                 console.warn('Transaction indexing is in progress.');
@@ -325,3 +331,3 @@ }
             ? response
-            : (format(transactionReceiptSchema, response, returnFormat !== null && returnFormat !== void 0 ? returnFormat : web3Context.defaultReturnFormat));
+            : format(transactionReceiptSchema, response, returnFormat !== null && returnFormat !== void 0 ? returnFormat : web3Context.defaultReturnFormat);
     });
@@ -360,3 +366,5 @@ }
                 }
-                let transactionFormatted = formatTransaction(Object.assign(Object.assign({}, transaction), { from: getTransactionFromOrToAttr('from', web3Context, transaction), to: getTransactionFromOrToAttr('to', web3Context, transaction) }), ETH_DATA_FORMAT);
+                let transactionFormatted = formatTransaction(Object.assign(Object.assign({}, transaction), { from: getTransactionFromOrToAttr('from', web3Context, transaction), to: getTransactionFromOrToAttr('to', web3Context, transaction) }), ETH_DATA_FORMAT, {
+                    transactionSchema: web3Context.config.customTransactionSchema,
+                });
                 try {
@@ -488,3 +496,5 @@ transactionFormatted = yield sendTxHelper.populateGasPrice({
     return __awaiter(this, void 0, void 0, function* () {
-        const response = yield ethRpcMethods.signTransaction(web3Context.requestManager, formatTransaction(transaction, ETH_DATA_FORMAT));
+        const response = yield ethRpcMethods.signTransaction(web3Context.requestManager, formatTransaction(transaction, ETH_DATA_FORMAT, {
+            transactionSchema: web3Context.config.customTransactionSchema,
+        }));
         // Some clients only return the encoded signed transaction (e.g. Ganache)
@@ -499,2 +509,3 @@ // while clients such as Geth return the desired SignedTransactionInfoAPI object
                 tx: formatTransaction(response.tx, returnFormat, {
+                    transactionSchema: web3Context.config.customTransactionSchema,
                     fillInputAndData: true,
@@ -516,3 +527,5 @@ }),
             : format({ format: 'uint' }, blockNumber, ETH_DATA_FORMAT);
-        const response = yield ethRpcMethods.call(web3Context.requestManager, formatTransaction(transaction, ETH_DATA_FORMAT), blockNumberFormatted);
+        const response = yield ethRpcMethods.call(web3Context.requestManager, formatTransaction(transaction, ETH_DATA_FORMAT, {
+            transactionSchema: web3Context.config.customTransactionSchema,
+        }), blockNumberFormatted);
         return format({ format: 'bytes' }, response, returnFormat);
@@ -528,3 +541,5 @@ });
     return __awaiter(this, void 0, void 0, function* () {
-        const transactionFormatted = formatTransaction(transaction, ETH_DATA_FORMAT);
+        const transactionFormatted = formatTransaction(transaction, ETH_DATA_FORMAT, {
+            transactionSchema: web3Context.config.customTransactionSchema,
+        });
         const blockNumberFormatted = isBlockTag(blockNumber)
@@ -624,3 +639,5 @@ ? blockNumber
             : format({ format: 'uint' }, blockNumber, ETH_DATA_FORMAT);
-        const response = (yield ethRpcMethods.createAccessList(web3Context.requestManager, formatTransaction(transaction, ETH_DATA_FORMAT), blockNumberFormatted));
+        const response = (yield ethRpcMethods.createAccessList(web3Context.requestManager, formatTransaction(transaction, ETH_DATA_FORMAT, {
+            transactionSchema: web3Context.config.customTransactionSchema,
+        }), blockNumberFormatted));
         return format(accessListResultSchema, response, returnFormat !== null && returnFormat !== void 0 ? returnFormat : web3Context.defaultReturnFormat);
@@ -627,0 +644,0 @@ });

lib/esm/utils/decode_signed_transaction.js

@@ -12,8 +12,13 @@ import { bytesToHex, format, hexToBytes, keccak256 } from 'web3-utils';
  */
-export function decodeSignedTransaction(encodedSignedTransaction, returnFormat, options = { fillInputAndData: false }) {
+export function decodeSignedTransaction(encodedSignedTransaction, returnFormat, options = {
+    fillInputAndData: false,
+}) {
     return {
         raw: format({ format: 'bytes' }, encodedSignedTransaction, returnFormat),
-        tx: formatTransaction(Object.assign(Object.assign({}, TransactionFactory.fromSerializedData(hexToBytes(encodedSignedTransaction)).toJSON()), { hash: bytesToHex(keccak256(hexToBytes(encodedSignedTransaction))), type: detectRawTransactionType(hexToBytes(encodedSignedTransaction)) }), returnFormat, { fillInputAndData: options.fillInputAndData }),
+        tx: formatTransaction(Object.assign(Object.assign({}, TransactionFactory.fromSerializedData(hexToBytes(encodedSignedTransaction)).toJSON()), { hash: bytesToHex(keccak256(hexToBytes(encodedSignedTransaction))), type: detectRawTransactionType(hexToBytes(encodedSignedTransaction)) }), returnFormat, {
+            fillInputAndData: options.fillInputAndData,
+            transactionSchema: options.transactionSchema,
+        }),
     };
 }
 //# sourceMappingURL=decode_signed_transaction.js.map

lib/esm/utils/detect_transaction_type.js

@@ -67,3 +67,3 @@ /*
 };
-export const defaultTransactionTypeParser = (transaction) => {
+export const defaultTransactionTypeParser = transaction => {
     var _a, _b;
@@ -70,0 +70,0 @@ const tx = transaction;

lib/esm/utils/prepare_transaction_for_signing.js

@@ -103,6 +103,10 @@ /*
     }));
-    const formattedTransaction = formatTransaction(populatedTransaction, ETH_DATA_FORMAT);
-    validateTransactionForSigning(formattedTransaction);
+    const formattedTransaction = formatTransaction(populatedTransaction, ETH_DATA_FORMAT, {
+        transactionSchema: web3Context.config.customTransactionSchema,
+    });
+    validateTransactionForSigning(formattedTransaction, undefined, {
+        transactionSchema: web3Context.config.customTransactionSchema,
+    });
     return TransactionFactory.fromTxData(getEthereumjsTxDataFromTransaction(formattedTransaction), getEthereumjsTransactionOptions(formattedTransaction, web3Context));
 });
 //# sourceMappingURL=prepare_transaction_for_signing.js.map

lib/esm/utils/send_tx_helper.js

@@ -70,3 +70,4 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
                 let formatTx = tx;
-                if (isNullish(tx.data) && isNullish(tx.input) && isNullish(tx.gas)) { // eth.call runs into error if data isnt filled and gas is not defined, its a simple transaction so we fill it with 21000
+                if (isNullish(tx.data) && isNullish(tx.input) && isNullish(tx.gas)) {
+                    // eth.call runs into error if data isnt filled and gas is not defined, its a simple transaction so we fill it with 21000
                     formatTx = Object.assign(Object.assign({}, tx), { gas: 21000 });
@@ -73,0 +74,0 @@ }

lib/esm/validation.js

@@ -18,3 +18,3 @@ /*
 import { ETH_DATA_FORMAT, } from 'web3-types';
-import { isAddress, isHexStrict, isHexString32Bytes, isNullish, isUInt } from 'web3-validator';
+import { isAddress, isHexStrict, isHexString32Bytes, isNullish, isUInt, } from 'web3-validator';
 import { ChainMismatchError, HardforkMismatchError, ChainIdMismatchError, CommonOrChainAndHardforkError, Eip1559GasPriceError, InvalidGasOrGasPrice, InvalidMaxPriorityFeePerGasOrMaxFeePerGas, InvalidNonceOrChainIdError, InvalidTransactionCall, InvalidTransactionObjectError, InvalidTransactionWithSender, MissingChainOrHardforkError, MissingCustomChainError, MissingCustomChainIdError, MissingGasError, TransactionGasMismatchError, UnsupportedFeeMarketError, } from 'web3-errors';
@@ -237,3 +237,3 @@ import { formatTransaction } from './utils/format_transaction.js';
 };
-export const validateTransactionForSigning = (transaction, overrideMethod) => {
+export const validateTransactionForSigning = (transaction, overrideMethod, options = { transactionSchema: undefined }) => {
     if (!isNullish(overrideMethod)) {
@@ -249,3 +249,5 @@ overrideMethod(transaction);
     validateHardfork(transaction);
-    const formattedTransaction = formatTransaction(transaction, ETH_DATA_FORMAT);
+    const formattedTransaction = formatTransaction(transaction, ETH_DATA_FORMAT, {
+        transactionSchema: options.transactionSchema,
+    });
     validateGas(formattedTransaction);
@@ -252,0 +254,0 @@ if (isNullish(formattedTransaction.nonce) ||

lib/types/types.d.ts

 import { ContractExecutionError, TransactionRevertedWithoutReasonError, TransactionRevertInstructionError, TransactionRevertWithCustomError, InvalidResponseError, TransactionPollingTimeoutError } from 'web3-errors';
 import { FormatType, ETH_DATA_FORMAT, DataFormat, Bytes, ContractAbi, HexString, Numbers, Transaction, TransactionReceipt, TransactionWithFromAndToLocalWalletIndex, TransactionWithFromLocalWalletIndex, TransactionWithToLocalWalletIndex } from 'web3-types';
+import { Schema } from 'web3-validator';
 export declare type InternalTransaction = FormatType<Transaction, typeof ETH_DATA_FORMAT>;
@@ -46,2 +47,6 @@ export declare type SendTransactionEventsBase<ReturnFormat extends DataFormat, TxType> = {
 }
+export declare type CustomTransactionSchema = {
+    type: string;
+    properties: Record<string, Schema>;
+};
 //# sourceMappingURL=types.d.ts.map

lib/types/utils/decode_signed_transaction.d.ts

 import { DataFormat, HexStringBytes, SignedTransactionInfoAPI } from 'web3-types';
+import { type CustomTransactionSchema } from '../types.js';
 /**
@@ -11,3 +12,4 @@ * Decodes an [RLP](https://ethereum.org/en/developers/docs/data-structures-and-encoding/rlp/#top) encoded transaction.
     fillInputAndData?: boolean;
+    transactionSchema?: CustomTransactionSchema;
 }): SignedTransactionInfoAPI;
 //# sourceMappingURL=decode_signed_transaction.d.ts.map

lib/types/utils/format_transaction.d.ts

 import { Transaction, DataFormat, DEFAULT_RETURN_FORMAT, FormatType } from 'web3-types';
 import { ValidationSchemaInput } from 'web3-validator';
-import { transactionSchema } from '../schemas.js';
+import { type CustomTransactionSchema } from '../types.js';
 export declare function formatTransaction<ReturnFormat extends DataFormat = typeof DEFAULT_RETURN_FORMAT, TransactionType extends Transaction = Transaction>(transaction: TransactionType, returnFormat?: ReturnFormat, options?: {
-    transactionSchema?: ValidationSchemaInput | typeof transactionSchema;
+    transactionSchema?: ValidationSchemaInput | CustomTransactionSchema | undefined;
     fillInputAndData?: boolean;
 }): FormatType<TransactionType, ReturnFormat>;
 //# sourceMappingURL=format_transaction.d.ts.map

lib/types/validation.d.ts

 import { AccessList, AccessListEntry, BaseTransactionAPI, Transaction1559UnsignedAPI, Transaction2930UnsignedAPI, TransactionCall, TransactionLegacyUnsignedAPI, TransactionWithSenderAPI } from 'web3-types';
-import { InternalTransaction } from './types.js';
+import { CustomTransactionSchema, InternalTransaction } from './types.js';
 export declare function isBaseTransaction(value: BaseTransactionAPI): boolean;
@@ -24,3 +24,5 @@ export declare function isAccessListEntry(value: AccessListEntry): boolean;
 export declare const validateGas: (transaction: InternalTransaction) => void;
-export declare const validateTransactionForSigning: (transaction: InternalTransaction, overrideMethod?: ((transaction: InternalTransaction) => void) | undefined) => void;
+export declare const validateTransactionForSigning: (transaction: InternalTransaction, overrideMethod?: ((transaction: InternalTransaction) => void) | undefined, options?: {
+    transactionSchema?: CustomTransactionSchema;
+}) => void;
 //# sourceMappingURL=validation.d.ts.map

package.json

 {
 	"name": "web3-eth",
-	"version": "4.8.3-dev.f87ffbe.0+f87ffbe",
+	"version": "4.9.0",
 	"description": "Web3 module to interact with the Ethereum blockchain and smart contracts.",
@@ -43,3 +43,3 @@ "main": "./lib/commonjs/index.js",
 		"test:unit": "jest --config=./test/unit/jest.config.js",
-		"test:integration": "jest --config=./test/integration/jest.config.js --runInBand --forceExit",
+		"test:integration": "jest --config=./test/integration/jest.config.js --runInBand",
 		"test:coverage:integration": "jest --config=./test/integration/jest.config.js --runInBand --forceExit --coverage=true --coverage-reporters=text",
@@ -63,18 +63,18 @@ "test:e2e:electron": "npx cypress run --headless --browser electron",
 		"typescript": "^4.7.4",
-		"web3-providers-http": "4.1.1-dev.f87ffbe.0+f87ffbe"
+		"web3-providers-http": "^4.2.0"
 	},
 	"dependencies": {
 		"setimmediate": "^1.0.5",
-		"web3-core": "4.5.1-dev.f87ffbe.0+f87ffbe",
-		"web3-errors": "1.2.2-dev.f87ffbe.0+f87ffbe",
-		"web3-eth-abi": "4.2.4-dev.f87ffbe.0+f87ffbe",
-		"web3-eth-accounts": "4.1.4-dev.f87ffbe.0+f87ffbe",
-		"web3-net": "4.1.1-dev.f87ffbe.0+f87ffbe",
-		"web3-providers-ws": "4.0.9-dev.f87ffbe.0+f87ffbe",
-		"web3-rpc-methods": "1.3.1-dev.f87ffbe.0+f87ffbe",
-		"web3-types": "1.7.1-dev.f87ffbe.0+f87ffbe",
-		"web3-utils": "4.3.2-dev.f87ffbe.0+f87ffbe",
-		"web3-validator": "2.0.7-dev.f87ffbe.0+f87ffbe"
+		"web3-core": "^4.6.0",
+		"web3-errors": "^1.3.0",
+		"web3-eth-abi": "^4.2.4",
+		"web3-eth-accounts": "^4.2.1",
+		"web3-net": "^4.1.0",
+		"web3-providers-ws": "^4.0.8",
+		"web3-rpc-methods": "^1.3.0",
+		"web3-types": "^1.8.0",
+		"web3-utils": "^4.3.1",
+		"web3-validator": "^2.0.6"
 	},
-	"gitHead": "f87ffbe1efc38a33df241adf97d2b82e9cede7c8"
+	"gitHead": "07993314c5db2dfaedb51bf1243c99568b6e070f"
 }

src/rpc_method_wrappers.ts

@@ -299,6 +299,6 @@ /*
 			transactions: res.transactions ?? [],
-		}
+		};
 		return result;
 	}
-	
+
 	return res;
@@ -433,2 +433,3 @@ }
 		: formatTransaction(response, returnFormat, {
+				transactionSchema: web3Context.config.customTransactionSchema,
 				fillInputAndData: true,
@@ -453,2 +454,3 @@ });
 			{
+				transactionSchema: web3Context.config.customTransactionSchema,
 				fillInputAndData: true,
@@ -494,2 +496,3 @@ },
 		: formatTransaction(response, returnFormat ?? web3Context.defaultReturnFormat, {
+				transactionSchema: web3Context.config.customTransactionSchema,
 				fillInputAndData: true,
@@ -515,3 +518,3 @@ });
 	try {
-		 response = await ethRpcMethods.getTransactionReceipt(
+		response = await ethRpcMethods.getTransactionReceipt(
 			web3Context.requestManager,
@@ -522,16 +525,20 @@ transactionHashFormatted,
 		// geth indexing error, we poll until transactions stopped indexing
-		if (typeof error === 'object' && !isNullish(error) && 'message' in error && (error as { message: string }).message === 'transaction indexing is in progress') { 
-			console.warn('Transaction indexing is in progress.')
+		if (
+			typeof error === 'object' &&
+			!isNullish(error) &&
+			'message' in error &&
+			(error as { message: string }).message === 'transaction indexing is in progress'
+		) {
+			console.warn('Transaction indexing is in progress.');
 		} else {
 			throw error;
 		}
-		
 	}
 	return isNullish(response)
 		? response
-		: (format(
+		: format(
 				transactionReceiptSchema,
 				response as unknown as TransactionReceipt,
 				returnFormat ?? web3Context.defaultReturnFormat,
-		  ));
+		  );
 }
@@ -581,3 +588,3 @@
 	options: SendTransactionOptions<ResolveType> = { checkRevertBeforeSending: true },
-	transactionMiddleware?: TransactionMiddleware
+	transactionMiddleware?: TransactionMiddleware,
 ): Web3PromiEvent<ResolveType, SendTransactionEvents<ReturnFormat>> {
@@ -595,5 +602,5 @@ const promiEvent = new Web3PromiEvent<ResolveType, SendTransactionEvents<ReturnFormat>>(
 
-					let transaction = {...transactionObj};
-					
-					if(!isNullish(transactionMiddleware)){
+					let transaction = { ...transactionObj };
+
+					if (!isNullish(transactionMiddleware)) {
 						transaction = await transactionMiddleware.processTransaction(transaction);
@@ -613,2 +620,5 @@ }
 						ETH_DATA_FORMAT,
+						{
+							transactionSchema: web3Context.config.customTransactionSchema,
+						},
 					);
@@ -855,3 +865,5 @@
 		web3Context.requestManager,
-		formatTransaction(transaction, ETH_DATA_FORMAT),
+		formatTransaction(transaction, ETH_DATA_FORMAT, {
+			transactionSchema: web3Context.config.customTransactionSchema,
+		}),
 	);
@@ -871,2 +883,3 @@ // Some clients only return the encoded signed transaction (e.g. Ganache)
 				tx: formatTransaction((response as SignedTransactionInfoAPI).tx, returnFormat, {
+					transactionSchema: web3Context.config.customTransactionSchema,
 					fillInputAndData: true,
@@ -895,3 +908,5 @@ }),
 		web3Context.requestManager,
-		formatTransaction(transaction, ETH_DATA_FORMAT),
+		formatTransaction(transaction, ETH_DATA_FORMAT, {
+			transactionSchema: web3Context.config.customTransactionSchema,
+		}),
 		blockNumberFormatted,
@@ -914,3 +929,5 @@ );
 ) {
-	const transactionFormatted = formatTransaction(transaction, ETH_DATA_FORMAT);
+	const transactionFormatted = formatTransaction(transaction, ETH_DATA_FORMAT, {
+		transactionSchema: web3Context.config.customTransactionSchema,
+	});
 	const blockNumberFormatted = isBlockTag(blockNumber as string)
@@ -1086,3 +1103,5 @@ ? (blockNumber as BlockTag)
 		web3Context.requestManager,
-		formatTransaction(transaction, ETH_DATA_FORMAT),
+		formatTransaction(transaction, ETH_DATA_FORMAT, {
+			transactionSchema: web3Context.config.customTransactionSchema,
+		}),
 		blockNumberFormatted,
@@ -1089,0 +1108,0 @@ )) as unknown as AccessListResult;

src/schemas.ts

@@ -260,6 +260,6 @@ /*
 	properties: {
-        baseFeePerGas: {
+		baseFeePerGas: {
 			format: 'uint',
 		},
-        blobGasUsed: {
+		blobGasUsed: {
 			format: 'uint',
@@ -349,3 +349,3 @@ },
 		},
-        withdrawals: {
+		withdrawals: {
 			type: 'array',
@@ -356,3 +356,3 @@ items: {
 		},
-        withdrawalsRoot: {
+		withdrawalsRoot: {
 			format: 'bytes32',
@@ -366,12 +366,12 @@ },
 	properties: {
-        author: {
+		author: {
 			format: 'bytes32',
 		},
-        excessDataGas: {
+		excessDataGas: {
 			format: 'uint',
 		},
-        baseFeePerGas: {
+		baseFeePerGas: {
 			format: 'uint',
 		},
-        blobGasUsed: {
+		blobGasUsed: {
 			format: 'uint',
@@ -451,3 +451,3 @@ },
 		},
-        withdrawals: {
+		withdrawals: {
 			type: 'array',
@@ -458,3 +458,3 @@ items: {
 		},
-        withdrawalsRoot: {
+		withdrawalsRoot: {
 			format: 'bytes32',
@@ -461,0 +461,0 @@ },

src/types.ts

@@ -40,2 +40,3 @@ /*
 } from 'web3-types';
+import { Schema } from 'web3-validator';
 
@@ -96,14 +97,19 @@ export type InternalTransaction = FormatType<Transaction, typeof ETH_DATA_FORMAT>;
 
-export type TransactionMiddlewareData = Transaction
-| TransactionWithFromLocalWalletIndex
-| TransactionWithToLocalWalletIndex
-| TransactionWithFromAndToLocalWalletIndex;
+export type TransactionMiddlewareData =
+	| Transaction
+	| TransactionWithFromLocalWalletIndex
+	| TransactionWithToLocalWalletIndex
+	| TransactionWithFromAndToLocalWalletIndex;
 
-export interface TransactionMiddleware{
+export interface TransactionMiddleware {
 	// for transaction processing before signing
 	processTransaction(
-		transaction:  TransactionMiddlewareData,
+		transaction: TransactionMiddlewareData,
 		options?: { [key: string]: unknown },
 	): Promise<TransactionMiddlewareData>;
+}
 
-}
+export type CustomTransactionSchema = {
+	type: string;
+	properties: Record<string, Schema>;
+};

src/utils/decode_signed_transaction.ts

@@ -27,2 +27,3 @@ /*
 import { formatTransaction } from './format_transaction.js';
+import { type CustomTransactionSchema } from '../types.js';
 
@@ -39,3 +40,5 @@ /**
 	returnFormat: ReturnFormat,
-	options: { fillInputAndData?: boolean } = { fillInputAndData: false },
+	options: { fillInputAndData?: boolean; transactionSchema?: CustomTransactionSchema } = {
+		fillInputAndData: false,
+	},
 ): SignedTransactionInfoAPI {
@@ -53,5 +56,8 @@ return {
 			returnFormat,
-			{ fillInputAndData: options.fillInputAndData },
+			{
+				fillInputAndData: options.fillInputAndData,
+				transactionSchema: options.transactionSchema,
+			},
 		),
 	};
 }

src/utils/detect_transaction_type.ts

@@ -78,5 +78,3 @@ /*
 
-export const defaultTransactionTypeParser: TransactionTypeParser = (
-	transaction
-) => {
+export const defaultTransactionTypeParser: TransactionTypeParser = transaction => {
 	const tx = transaction as unknown as Transaction;
@@ -143,3 +141,3 @@ if (!isNullish(tx.type)) {
 	(web3Context?.transactionTypeParser ?? defaultTransactionTypeParser)(
-		transaction as unknown as Record<string, unknown>
+		transaction as unknown as Record<string, unknown>,
 	);
@@ -146,0 +144,0 @@

src/utils/format_transaction.ts

@@ -23,3 +23,4 @@ /*
 
-import { transactionInfoSchema, transactionSchema } from '../schemas.js';
+import { transactionInfoSchema } from '../schemas.js';
+import { type CustomTransactionSchema } from '../types.js';
 
@@ -33,3 +34,3 @@ export function formatTransaction<
 	options: {
-		transactionSchema?: ValidationSchemaInput | typeof transactionSchema;
+		transactionSchema?: ValidationSchemaInput | CustomTransactionSchema | undefined;
 		fillInputAndData?: boolean;
@@ -36,0 +37,0 @@ } = {

src/utils/prepare_transaction_for_signing.ts

@@ -137,10 +137,14 @@ /*
 	})) as unknown as PopulatedUnsignedTransaction;
-	const formattedTransaction = formatTransaction(
-		populatedTransaction,
-		ETH_DATA_FORMAT,
-	) as unknown as FormatType<PopulatedUnsignedTransaction, typeof ETH_DATA_FORMAT>;
+	const formattedTransaction = formatTransaction(populatedTransaction, ETH_DATA_FORMAT, {
+		transactionSchema: web3Context.config.customTransactionSchema,
+	}) as unknown as FormatType<PopulatedUnsignedTransaction, typeof ETH_DATA_FORMAT>;
+
 	validateTransactionForSigning(
 		formattedTransaction as unknown as FormatType<Transaction, typeof ETH_DATA_FORMAT>,
+		undefined,
+		{
+			transactionSchema: web3Context.config.customTransactionSchema,
+		},
 	);
-	
+
 	return TransactionFactory.fromTxData(
@@ -147,0 +151,0 @@ getEthereumjsTxDataFromTransaction(formattedTransaction),

src/utils/reject_if_block_timeout.ts

@@ -37,21 +37,20 @@ /*
 	const pollingInterval = web3Context.transactionPollingInterval;
-	const [intervalId, promiseToError] =
-		rejectIfConditionAtInterval(async () => {
-			let lastBlockNumber;
-			try {
-				lastBlockNumber = await getBlockNumber(web3Context, NUMBER_DATA_FORMAT);
-			} catch (error) {
-				console.warn('An error happen while trying to get the block number', error);
-				return undefined;
-			}
-			const numberOfBlocks = lastBlockNumber - starterBlockNumber;
-			if (numberOfBlocks >= web3Context.transactionBlockTimeout) {
-				return new TransactionBlockTimeoutError({
-					starterBlockNumber,
-					numberOfBlocks,
-					transactionHash,
-				});
-			}
+	const [intervalId, promiseToError] = rejectIfConditionAtInterval(async () => {
+		let lastBlockNumber;
+		try {
+			lastBlockNumber = await getBlockNumber(web3Context, NUMBER_DATA_FORMAT);
+		} catch (error) {
+			console.warn('An error happen while trying to get the block number', error);
 			return undefined;
-		}, pollingInterval);
+		}
+		const numberOfBlocks = lastBlockNumber - starterBlockNumber;
+		if (numberOfBlocks >= web3Context.transactionBlockTimeout) {
+			return new TransactionBlockTimeoutError({
+				starterBlockNumber,
+				numberOfBlocks,
+				transactionHash,
+			});
+		}
+		return undefined;
+	}, pollingInterval);
 
@@ -58,0 +57,0 @@ const clean = () => {

src/utils/send_tx_helper.ts

@@ -126,9 +126,14 @@ /*
 			let formatTx = tx;
-			if (isNullish(tx.data) && isNullish(tx.input) && isNullish(tx.gas)) { // eth.call runs into error if data isnt filled and gas is not defined, its a simple transaction so we fill it with 21000
+			if (isNullish(tx.data) && isNullish(tx.input) && isNullish(tx.gas)) {
+				// eth.call runs into error if data isnt filled and gas is not defined, its a simple transaction so we fill it with 21000
 				formatTx = {
 					...tx,
-					gas: 21000
-				}
+					gas: 21000,
+				};
 			}
-			const reason = await getRevertReason(this.web3Context, formatTx, this.options.contractAbi);
+			const reason = await getRevertReason(
+				this.web3Context,
+				formatTx,
+				this.options.contractAbi,
+			);
 			if (reason !== undefined) {
@@ -135,0 +140,0 @@ throw await getTransactionError<ReturnFormat>(

src/utils/watch_transaction_by_polling.ts

@@ -59,3 +59,3 @@ /*
 		(async () => {
-			if (confirmations >= web3Context.transactionConfirmationBlocks){
+			if (confirmations >= web3Context.transactionConfirmationBlocks) {
 				clearInterval(intervalId);
@@ -62,0 +62,0 @@ return;

src/validation.ts

@@ -30,4 +30,10 @@ /*
 } from 'web3-types';
-import { isAddress, isHexStrict, isHexString32Bytes, isNullish, isUInt } from 'web3-validator';
 import {
+	isAddress,
+	isHexStrict,
+	isHexString32Bytes,
+	isNullish,
+	isUInt,
+} from 'web3-validator';
+import {
 	ChainMismatchError,
@@ -52,3 +58,3 @@ HardforkMismatchError,
 import { formatTransaction } from './utils/format_transaction.js';
-import { InternalTransaction } from './types.js';
+import { CustomTransactionSchema, InternalTransaction } from './types.js';
 
@@ -287,2 +293,5 @@ export function isBaseTransaction(value: BaseTransactionAPI): boolean {
 	overrideMethod?: (transaction: InternalTransaction) => void,
+	options: {
+		transactionSchema?: CustomTransactionSchema;
+	} = { transactionSchema: undefined },
 ) => {
@@ -302,3 +311,5 @@ if (!isNullish(overrideMethod)) {
 
-	const formattedTransaction = formatTransaction(transaction as Transaction, ETH_DATA_FORMAT);
+	const formattedTransaction = formatTransaction(transaction as Transaction, ETH_DATA_FORMAT, {
+		transactionSchema: options.transactionSchema,
+	});
 	validateGas(formattedTransaction);
@@ -305,0 +316,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

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

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1338666

increased by0.44%

Lines of code

23745

increased by0.56%

Number of low quality alerts

1

decreased by-50%

Number of medium supply chain risk alerts

0

decreased by-100%

Dependency changes

• + Added@ethereumjs/rlp@4.0.1(transitive)

• + Added@noble/curves@1.4.2(transitive)

• + Added@noble/hashes@1.4.0(transitive)

• + Added@scure/base@1.1.9(transitive)

• + Added@scure/bip32@1.4.0(transitive)

• + Added@scure/bip39@1.3.0(transitive)

• + Added@types/node@22.9.0(transitive)

• + Added@types/ws@8.5.3(transitive)

• + Addedabitype@0.7.1(transitive)

• + Addedavailable-typed-arrays@1.0.7(transitive)

• + Addedcall-bind@1.0.7(transitive)

• + Addedcrc-32@1.2.2(transitive)

• + Addedcross-fetch@4.0.0(transitive)

• + Addeddefine-data-property@1.1.4(transitive)

• + Addedes-define-property@1.0.0(transitive)

• + Addedes-errors@1.3.0(transitive)

• + Addedethereum-cryptography@2.2.1(transitive)

• + Addedeventemitter3@5.0.1(transitive)

• + Addedfor-each@0.3.3(transitive)

• + Addedfunction-bind@1.1.2(transitive)

• + Addedget-intrinsic@1.2.4(transitive)

• + Addedgopd@1.0.1(transitive)

• + Addedhas-property-descriptors@1.0.2(transitive)

• + Addedhas-proto@1.0.3(transitive)

• + Addedhas-symbols@1.0.3(transitive)

• + Addedhas-tostringtag@1.0.2(transitive)

• + Addedhasown@2.0.2(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedis-arguments@1.1.1(transitive)

• + Addedis-callable@1.2.7(transitive)

• + Addedis-generator-function@1.0.10(transitive)

• + Addedis-typed-array@1.1.13(transitive)

• + Addedisomorphic-ws@5.0.0(transitive)

• + Addednode-fetch@2.7.0(transitive)

• + Addedpossible-typed-array-names@1.0.0(transitive)

• + Addedset-function-length@1.2.2(transitive)

• + Addedtr46@0.0.3(transitive)

• + Addedtypescript@5.6.3(transitive)

• + Addedundici-types@6.19.8(transitive)

• + Addedutil@0.12.5(transitive)

• + Addedweb3-core@4.7.0(transitive)

• + Addedweb3-errors@1.3.0(transitive)

• + Addedweb3-eth-abi@4.4.0(transitive)

• + Addedweb3-eth-accounts@4.3.0(transitive)

• + Addedweb3-eth-iban@4.0.7(transitive)

• + Addedweb3-net@4.1.0(transitive)

• + Addedweb3-providers-http@4.2.0(transitive)

• + Addedweb3-providers-ipc@4.0.7(transitive)

• + Addedweb3-providers-ws@4.0.8(transitive)

• + Addedweb3-rpc-methods@1.3.0(transitive)

• + Addedweb3-types@1.9.0(transitive)

• + Addedweb3-utils@4.3.2(transitive)

• + Addedweb3-validator@2.0.6(transitive)

• + Addedwebidl-conversions@3.0.1(transitive)

• + Addedwhatwg-url@5.0.0(transitive)

• + Addedwhich-typed-array@1.1.15(transitive)

• + Addedws@8.18.0(transitive)

• + Addedzod@3.23.8(transitive)

• Updatedweb3-core@^4.6.0

• Updatedweb3-errors@^1.3.0

• Updatedweb3-eth-abi@^4.2.4

• Updatedweb3-eth-accounts@^4.2.1

• Updatedweb3-net@^4.1.0

• Updatedweb3-providers-ws@^4.0.8

• Updatedweb3-rpc-methods@^1.3.0

• Updatedweb3-types@^1.8.0

• Updatedweb3-utils@^4.3.1

• Updatedweb3-validator@^2.0.6