web-eth-abi 4.3.0

package/LICENSE

@@ -0,0 +1,14 @@
+This file is part of web3.js.
+
+web3.js is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+web3.js is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with web3.js.  If not, see <http://www.gnu.org/licenses/>.

package/README.md

@@ -0,0 +1,59 @@
+<p align="center">
+  <img src="assets/logo/web3js.jpg" width="500" alt="web3.js" />
+</p>
+
+# web3.js - Web3-Eth-Abi
+
+![ES Version](https://img.shields.io/badge/ES-2020-yellow)
+![Node Version](https://img.shields.io/badge/node-14.x-green)
+[![NPM Package][npm-image]][npm-url]
+[![Downloads][downloads-image]][npm-url]
+
+This is a sub-package of [web3.js][repo].
+
+`web3-eth-abi` contains functions for the encode and decode EVM in/output.
+
+## Installation
+
+You can install the package either using [NPM](https://www.npmjs.com/package/web3-eth-abi) or using [Yarn](https://yarnpkg.com/package/web3-eth-abi)
+
+### Using NPM
+
+```bash
+npm install web3-eth-abi
+```
+
+### Using Yarn
+
+```bash
+yarn add web3-eth-abi
+```
+
+## Getting Started
+
+-   :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/web3.js/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP)
+    ![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord)
+
+## Prerequisites
+
+-   :gear: [NodeJS](https://nodejs.org/) (LTS/Fermium)
+-   :toolbox: [Yarn](https://yarnpkg.com/)/[Lerna](https://lerna.js.org/)
+
+## Package.json Scripts
+
+| Script           | Description                                        |
+| ---------------- | -------------------------------------------------- |
+| clean            | Uses `rimraf` to remove `dist/`                    |
+| build            | Uses `tsc` to build package and dependent packages |
+| lint             | Uses `eslint` to lint package                      |
+| lint:fix         | Uses `eslint` to check and fix any warnings        |
+| format           | Uses `prettier` to format the code                 |
+| test             | Uses `jest` to run unit tests                      |
+| test:integration | Uses `jest` to run tests under `/test/integration` |
+| test:unit        | Uses `jest` to run tests under `/test/unit`        |
+
+[docs]: https://docs.web3js.org/
+[repo]: https://github.com/web3/web3.js/tree/4.x/packages/web3-eth-abi
+[npm-image]: https://img.shields.io/github/package-json/v/web3/web3.js/4.x?filename=packages%2Fweb3-eth-abi%2Fpackage.json
+[npm-url]: https://npmjs.org/package/web3-eth-abi
+[downloads-image]: https://img.shields.io/npm/dm/web3-eth-abi?label=npm%20downloads

package/lib/commonjs/api/errors_api.d.ts

@@ -0,0 +1,5 @@
+import { AbiErrorFragment } from 'web3-types';
+/**
+ * Encodes the error name to its ABI signature, which are the sha3 hash of the error name including input types.
+ */
+export declare const encodeErrorSignature: (functionName: string | AbiErrorFragment) => string;

package/lib/commonjs/api/errors_api.js

@@ -0,0 +1,44 @@
+"use strict";
+/*
+This file is part of web3.js.
+
+web3.js is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+web3.js is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.encodeErrorSignature = void 0;
+/**
+ *
+ *  @module ABI
+ */
+const web3_utils_1 = require("web3-utils");
+const web3_errors_1 = require("web3-errors");
+const utils_js_1 = require("../utils.js");
+/**
+ * Encodes the error name to its ABI signature, which are the sha3 hash of the error name including input types.
+ */
+const encodeErrorSignature = (functionName) => {
+    if (typeof functionName !== 'string' && !(0, utils_js_1.isAbiErrorFragment)(functionName)) {
+        throw new web3_errors_1.AbiError('Invalid parameter value in encodeErrorSignature');
+    }
+    let name;
+    if (functionName && (typeof functionName === 'function' || typeof functionName === 'object')) {
+        name = (0, utils_js_1.jsonInterfaceMethodToString)(functionName);
+    }
+    else {
+        name = functionName;
+    }
+    return (0, web3_utils_1.sha3Raw)(name);
+};
+exports.encodeErrorSignature = encodeErrorSignature;
+//# sourceMappingURL=errors_api.js.map

package/lib/commonjs/api/errors_api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors_api.js","sourceRoot":"","sources":["../../../src/api/errors_api.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;EAeE;;;AAEF;;;GAGG;AAEH,2CAAqC;AACrC,6CAAuC;AAEvC,0CAA8E;AAE9E;;GAEG;AACI,MAAM,oBAAoB,GAAG,CAAC,YAAuC,EAAU,EAAE;IACvF,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,CAAC,IAAA,6BAAkB,EAAC,YAAY,CAAC,EAAE;QAC1E,MAAM,IAAI,sBAAQ,CAAC,iDAAiD,CAAC,CAAC;KACtE;IAED,IAAI,IAAY,CAAC;IAEjB,IAAI,YAAY,IAAI,CAAC,OAAO,YAAY,KAAK,UAAU,IAAI,OAAO,YAAY,KAAK,QAAQ,CAAC,EAAE;QAC7F,IAAI,GAAG,IAAA,sCAA2B,EAAC,YAAY,CAAC,CAAC;KACjD;SAAM;QACN,IAAI,GAAG,YAAY,CAAC;KACpB;IAED,OAAO,IAAA,oBAAO,EAAC,IAAI,CAAC,CAAC;AACtB,CAAC,CAAC;AAdW,QAAA,oBAAoB,wBAc/B"}

package/lib/commonjs/api/events_api.d.ts

@@ -0,0 +1,51 @@
+import { AbiEventFragment } from 'web3-types';
+/**
+ * Encodes the event name to its ABI signature, which are the sha3 hash of the event name including input types.
+ * @param functionName - The event name to encode, or the {@link AbiEventFragment} object of the event. If string, it has to be in the form of `eventName(param1Type,param2Type,...)`. eg: myEvent(uint256,bytes32).
+ * @returns - The ABI signature of the event.
+ *
+ * @example
+ * ```ts
+ * const event = web3.eth.abi.encodeEventSignature({
+ *   name: "myEvent",
+ *   type: "event",
+ *   inputs: [
+ *     {
+ *       type: "uint256",
+ *       name: "myNumber",
+ *     },
+ *     {
+ *       type: "bytes32",
+ *       name: "myBytes",
+ *     },
+ *   ],
+ * });
+ * console.log(event);
+ * > 0xf2eeb729e636a8cb783be044acf6b7b1e2c5863735b60d6daae84c366ee87d97
+ *
+ *  const event = web3.eth.abi.encodeEventSignature({
+ *   inputs: [
+ *     {
+ *       indexed: true,
+ *       name: "from",
+ *       type: "address",
+ *     },
+ *     {
+ *       indexed: true,
+ *       name: "to",
+ *       type: "address",
+ *     },
+ *     {
+ *       indexed: false,
+ *       name: "value",
+ *       type: "uint256",
+ *     },
+ *   ],
+ *   name: "Transfer",
+ *   type: "event",
+ * });
+ * console.log(event);
+ * > 0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef
+ * ```
+ */
+export declare const encodeEventSignature: (functionName: string | AbiEventFragment) => string;

package/lib/commonjs/api/events_api.js

@@ -0,0 +1,90 @@
+"use strict";
+/*
+This file is part of web3.js.
+
+web3.js is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+web3.js is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.encodeEventSignature = void 0;
+/**
+ *
+ *  @module ABI
+ */
+const web3_utils_1 = require("web3-utils");
+const web3_errors_1 = require("web3-errors");
+const utils_js_1 = require("../utils.js");
+/**
+ * Encodes the event name to its ABI signature, which are the sha3 hash of the event name including input types.
+ * @param functionName - The event name to encode, or the {@link AbiEventFragment} object of the event. If string, it has to be in the form of `eventName(param1Type,param2Type,...)`. eg: myEvent(uint256,bytes32).
+ * @returns - The ABI signature of the event.
+ *
+ * @example
+ * ```ts
+ * const event = web3.eth.abi.encodeEventSignature({
+ *   name: "myEvent",
+ *   type: "event",
+ *   inputs: [
+ *     {
+ *       type: "uint256",
+ *       name: "myNumber",
+ *     },
+ *     {
+ *       type: "bytes32",
+ *       name: "myBytes",
+ *     },
+ *   ],
+ * });
+ * console.log(event);
+ * > 0xf2eeb729e636a8cb783be044acf6b7b1e2c5863735b60d6daae84c366ee87d97
+ *
+ *  const event = web3.eth.abi.encodeEventSignature({
+ *   inputs: [
+ *     {
+ *       indexed: true,
+ *       name: "from",
+ *       type: "address",
+ *     },
+ *     {
+ *       indexed: true,
+ *       name: "to",
+ *       type: "address",
+ *     },
+ *     {
+ *       indexed: false,
+ *       name: "value",
+ *       type: "uint256",
+ *     },
+ *   ],
+ *   name: "Transfer",
+ *   type: "event",
+ * });
+ * console.log(event);
+ * > 0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef
+ * ```
+ */
+const encodeEventSignature = (functionName) => {
+    if (typeof functionName !== 'string' && !(0, utils_js_1.isAbiEventFragment)(functionName)) {
+        throw new web3_errors_1.AbiError('Invalid parameter value in encodeEventSignature');
+    }
+    let name;
+    if (functionName && (typeof functionName === 'function' || typeof functionName === 'object')) {
+        name = (0, utils_js_1.jsonInterfaceMethodToString)(functionName);
+    }
+    else {
+        name = functionName;
+    }
+    return (0, web3_utils_1.sha3Raw)(name);
+};
+exports.encodeEventSignature = encodeEventSignature;
+//# sourceMappingURL=events_api.js.map

package/lib/commonjs/api/events_api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events_api.js","sourceRoot":"","sources":["../../../src/api/events_api.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;EAeE;;;AAEF;;;GAGG;AAEH,2CAAqC;AACrC,6CAAuC;AAEvC,0CAA8E;AAE9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACI,MAAM,oBAAoB,GAAG,CAAC,YAAuC,EAAU,EAAE;IACvF,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,CAAC,IAAA,6BAAkB,EAAC,YAAY,CAAC,EAAE;QAC1E,MAAM,IAAI,sBAAQ,CAAC,iDAAiD,CAAC,CAAC;KACtE;IAED,IAAI,IAAY,CAAC;IAEjB,IAAI,YAAY,IAAI,CAAC,OAAO,YAAY,KAAK,UAAU,IAAI,OAAO,YAAY,KAAK,QAAQ,CAAC,EAAE;QAC7F,IAAI,GAAG,IAAA,sCAA2B,EAAC,YAAY,CAAC,CAAC;KACjD;SAAM;QACN,IAAI,GAAG,YAAY,CAAC;KACpB;IAED,OAAO,IAAA,oBAAO,EAAC,IAAI,CAAC,CAAC;AACtB,CAAC,CAAC;AAdW,QAAA,oBAAoB,wBAc/B"}

package/lib/commonjs/api/functions_api.d.ts

@@ -0,0 +1,92 @@
+import { AbiFunctionFragment } from 'web3-types';
+/**
+ * Encodes the function name to its ABI representation, which are the first 4 bytes of the sha3 of the function name including  types.
+ * The JSON interface spec documentation https://docs.soliditylang.org/en/latest/abi-spec.html#json
+ * @param functionName - The function name to encode or the `JSON interface` object of the function.
+ * If the passed parameter is a string, it has to be in the form of `functionName(param1Type,param2Type,...)`. eg: myFunction(uint256,uint32[],bytes10,bytes)
+ * @returns - The ABI signature of the function.
+ * @example
+ * ```ts
+ * const signature = web3.eth.abi.encodeFunctionSignature({
+ *   name: "myMethod",
+ *   type: "function",
+ *   inputs: [
+ *     {
+ *       type: "uint256",
+ *       name: "myNumber",
+ *     },
+ *     {
+ *       type: "string",
+ *       name: "myString",
+ *     },
+ *   ],
+ * });
+ * console.log(signature);
+ * > 0x24ee0097
+ *
+ * const signature = web3.eth.abi.encodeFunctionSignature('myMethod(uint256,string)')
+ * console.log(signature);
+ * > 0x24ee0097
+ *
+ * const signature = web3.eth.abi.encodeFunctionSignature('safeTransferFrom(address,address,uint256,bytes)');
+ * console.log(signature);
+ * > 0xb88d4fde
+ * ```
+ */
+export declare const encodeFunctionSignature: (functionName: string | AbiFunctionFragment) => string;
+/**
+ * Encodes a function call using its `JSON interface` object and given parameters.
+ * The JSON interface spec documentation https://docs.soliditylang.org/en/latest/abi-spec.html#json
+ * @param jsonInterface - The `JSON interface` object of the function.
+ * @param params - The parameters to encode
+ * @returns - The ABI encoded function call, which, means the function signature and the parameters passed.
+ * @example
+ * ```ts
+ * const sig = web3.eth.abi.encodeFunctionCall(
+ *   {
+ *     name: "myMethod",
+ *     type: "function",
+ *     inputs: [
+ *       {
+ *         type: "uint256",
+ *         name: "myNumber",
+ *       },
+ *       {
+ *         type: "string",
+ *         name: "myString",
+ *       },
+ *     ],
+ *   },
+ *   ["2345675643", "Hello!%"]
+ * );
+ * console.log(sig);
+ * > 0x24ee0097000000000000000000000000000000000000000000000000000000008bd02b7b0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000748656c6c6f212500000000000000000000000000000000000000000000000000
+ *
+ *
+ *
+ * const sig = web3.eth.abi.encodeFunctionCall(
+ *   {
+ *     inputs: [
+ *       {
+ *         name: "account",
+ *         type: "address",
+ *       },
+ *     ],
+ *     name: "balanceOf",
+ *     outputs: [
+ *       {
+ *         name: "",
+ *         type: "uint256",
+ *       },
+ *     ],
+ *     stateMutability: "view",
+ *     type: "function",
+ *   },
+ *   ["0x1234567890123456789012345678901234567890"]
+ * );
+ *
+ * console.log(sig);
+ * > 0x70a082310000000000000000000000001234567890123456789012345678901234567890
+ * ```
+ */
+export declare const encodeFunctionCall: (jsonInterface: AbiFunctionFragment, params: unknown[]) => string;

package/lib/commonjs/api/functions_api.js

@@ -0,0 +1,139 @@
+"use strict";
+/*
+This file is part of web3.js.
+
+web3.js is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+web3.js is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.encodeFunctionCall = exports.encodeFunctionSignature = void 0;
+/**
+ *
+ *  @module ABI
+ */
+const web3_errors_1 = require("web3-errors");
+const web3_utils_1 = require("web3-utils");
+const utils_js_1 = require("../utils.js");
+const parameters_api_js_1 = require("./parameters_api.js");
+/**
+ * Encodes the function name to its ABI representation, which are the first 4 bytes of the sha3 of the function name including  types.
+ * The JSON interface spec documentation https://docs.soliditylang.org/en/latest/abi-spec.html#json
+ * @param functionName - The function name to encode or the `JSON interface` object of the function.
+ * If the passed parameter is a string, it has to be in the form of `functionName(param1Type,param2Type,...)`. eg: myFunction(uint256,uint32[],bytes10,bytes)
+ * @returns - The ABI signature of the function.
+ * @example
+ * ```ts
+ * const signature = web3.eth.abi.encodeFunctionSignature({
+ *   name: "myMethod",
+ *   type: "function",
+ *   inputs: [
+ *     {
+ *       type: "uint256",
+ *       name: "myNumber",
+ *     },
+ *     {
+ *       type: "string",
+ *       name: "myString",
+ *     },
+ *   ],
+ * });
+ * console.log(signature);
+ * > 0x24ee0097
+ *
+ * const signature = web3.eth.abi.encodeFunctionSignature('myMethod(uint256,string)')
+ * console.log(signature);
+ * > 0x24ee0097
+ *
+ * const signature = web3.eth.abi.encodeFunctionSignature('safeTransferFrom(address,address,uint256,bytes)');
+ * console.log(signature);
+ * > 0xb88d4fde
+ * ```
+ */
+const encodeFunctionSignature = (functionName) => {
+    if (typeof functionName !== 'string' && !(0, utils_js_1.isAbiFunctionFragment)(functionName)) {
+        throw new web3_errors_1.AbiError('Invalid parameter value in encodeFunctionSignature');
+    }
+    let name;
+    if (functionName && (typeof functionName === 'function' || typeof functionName === 'object')) {
+        name = (0, utils_js_1.jsonInterfaceMethodToString)(functionName);
+    }
+    else {
+        name = functionName;
+    }
+    return (0, web3_utils_1.sha3Raw)(name).slice(0, 10);
+};
+exports.encodeFunctionSignature = encodeFunctionSignature;
+/**
+ * Encodes a function call using its `JSON interface` object and given parameters.
+ * The JSON interface spec documentation https://docs.soliditylang.org/en/latest/abi-spec.html#json
+ * @param jsonInterface - The `JSON interface` object of the function.
+ * @param params - The parameters to encode
+ * @returns - The ABI encoded function call, which, means the function signature and the parameters passed.
+ * @example
+ * ```ts
+ * const sig = web3.eth.abi.encodeFunctionCall(
+ *   {
+ *     name: "myMethod",
+ *     type: "function",
+ *     inputs: [
+ *       {
+ *         type: "uint256",
+ *         name: "myNumber",
+ *       },
+ *       {
+ *         type: "string",
+ *         name: "myString",
+ *       },
+ *     ],
+ *   },
+ *   ["2345675643", "Hello!%"]
+ * );
+ * console.log(sig);
+ * > 0x24ee0097000000000000000000000000000000000000000000000000000000008bd02b7b0000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000748656c6c6f212500000000000000000000000000000000000000000000000000
+ *
+ *
+ *
+ * const sig = web3.eth.abi.encodeFunctionCall(
+ *   {
+ *     inputs: [
+ *       {
+ *         name: "account",
+ *         type: "address",
+ *       },
+ *     ],
+ *     name: "balanceOf",
+ *     outputs: [
+ *       {
+ *         name: "",
+ *         type: "uint256",
+ *       },
+ *     ],
+ *     stateMutability: "view",
+ *     type: "function",
+ *   },
+ *   ["0x1234567890123456789012345678901234567890"]
+ * );
+ *
+ * console.log(sig);
+ * > 0x70a082310000000000000000000000001234567890123456789012345678901234567890
+ * ```
+ */
+const encodeFunctionCall = (jsonInterface, params) => {
+    var _a;
+    if (!(0, utils_js_1.isAbiFunctionFragment)(jsonInterface)) {
+        throw new web3_errors_1.AbiError('Invalid parameter value in encodeFunctionCall');
+    }
+    return `${(0, exports.encodeFunctionSignature)(jsonInterface)}${(0, parameters_api_js_1.encodeParameters)((_a = jsonInterface.inputs) !== null && _a !== void 0 ? _a : [], params !== null && params !== void 0 ? params : []).replace('0x', '')}`;
+};
+exports.encodeFunctionCall = encodeFunctionCall;
+//# sourceMappingURL=functions_api.js.map

package/lib/commonjs/api/functions_api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"functions_api.js","sourceRoot":"","sources":["../../../src/api/functions_api.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;EAeE;;;AAEF;;;GAGG;AACH,6CAAuC;AACvC,2CAAqC;AAErC,0CAAiF;AACjF,2DAAuD;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACI,MAAM,uBAAuB,GAAG,CAAC,YAA0C,EAAU,EAAE;IAC7F,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,CAAC,IAAA,gCAAqB,EAAC,YAAY,CAAC,EAAE;QAC7E,MAAM,IAAI,sBAAQ,CAAC,oDAAoD,CAAC,CAAC;KACzE;IAED,IAAI,IAAY,CAAC;IAEjB,IAAI,YAAY,IAAI,CAAC,OAAO,YAAY,KAAK,UAAU,IAAI,OAAO,YAAY,KAAK,QAAQ,CAAC,EAAE;QAC7F,IAAI,GAAG,IAAA,sCAA2B,EAAC,YAAY,CAAC,CAAC;KACjD;SAAM;QACN,IAAI,GAAG,YAAY,CAAC;KACpB;IAED,OAAO,IAAA,oBAAO,EAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AACnC,CAAC,CAAC;AAdW,QAAA,uBAAuB,2BAclC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACI,MAAM,kBAAkB,GAAG,CACjC,aAAkC,EAClC,MAAiB,EACR,EAAE;;IACX,IAAI,CAAC,IAAA,gCAAqB,EAAC,aAAa,CAAC,EAAE;QAC1C,MAAM,IAAI,sBAAQ,CAAC,+CAA+C,CAAC,CAAC;KACpE;IAED,OAAO,GAAG,IAAA,+BAAuB,EAAC,aAAa,CAAC,GAAG,IAAA,oCAAgB,EAClE,MAAA,aAAa,CAAC,MAAM,mCAAI,EAAE,EAC1B,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CACZ,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC;AACvB,CAAC,CAAC;AAZW,QAAA,kBAAkB,sBAY7B"}

package/lib/commonjs/api/logs_api.d.ts

@@ -0,0 +1,49 @@
+/**
+ *
+ *  @module ABI
+ */
+import { HexString, AbiParameter, DecodedParams } from 'web3-types';
+/**
+ * Decodes ABI-encoded log data and indexed topic data.
+ * @param inputs - A {@link AbiParameter} input array. See the [Solidity documentation](https://docs.soliditylang.org/en/develop/types.html) for a list of types.
+ * @param data - The ABI byte code in the `data` field of a log.
+ * @param topics - An array with the index parameter topics of the log, without the topic[0] if its a non-anonymous event, otherwise with topic[0]
+ * @returns - The result object containing the decoded parameters.
+ *
+ * @example
+ * ```ts
+ * let res = web3.eth.abi.decodeLog(
+ *    [
+ *      {
+ *        type: "string",
+ *        name: "myString",
+ *      },
+ *      {
+ *        type: "uint256",
+ *        name: "myNumber",
+ *        indexed: true,
+ *      },
+ *      {
+ *        type: "uint8",
+ *        name: "mySmallNumber",
+ *        indexed: true,
+ *      },
+ *    ],
+ *    "0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000748656c6c6f252100000000000000000000000000000000000000000000000000",
+ *    [
+ *      "0x000000000000000000000000000000000000000000000000000000000000f310",
+ *      "0x0000000000000000000000000000000000000000000000000000000000000010",
+ *    ]
+ *  );
+ * > {
+ *  '0': 'Hello%!',
+ *  '1': 62224n,
+ *  '2': 16n,
+ *  __length__: 3,
+ *  myString: 'Hello%!',
+ *  myNumber: 62224n,
+ *  mySmallNumber: 16n
+ * }
+ * ```
+ */
+export declare const decodeLog: <ReturnType_1 extends DecodedParams>(inputs: Array<AbiParameter> | ReadonlyArray<AbiParameter>, data: HexString, topics: string | string[]) => ReturnType_1;

package/lib/commonjs/api/logs_api.js

@@ -0,0 +1,107 @@
+"use strict";
+/*
+This file is part of web3.js.
+
+web3.js is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+web3.js is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decodeLog = void 0;
+const parameters_api_js_1 = require("./parameters_api.js");
+const STATIC_TYPES = ['bool', 'string', 'int', 'uint', 'address', 'fixed', 'ufixed'];
+const _decodeParameter = (inputType, clonedTopic) => inputType === 'string' ? clonedTopic : (0, parameters_api_js_1.decodeParameter)(inputType, clonedTopic);
+/**
+ * Decodes ABI-encoded log data and indexed topic data.
+ * @param inputs - A {@link AbiParameter} input array. See the [Solidity documentation](https://docs.soliditylang.org/en/develop/types.html) for a list of types.
+ * @param data - The ABI byte code in the `data` field of a log.
+ * @param topics - An array with the index parameter topics of the log, without the topic[0] if its a non-anonymous event, otherwise with topic[0]
+ * @returns - The result object containing the decoded parameters.
+ *
+ * @example
+ * ```ts
+ * let res = web3.eth.abi.decodeLog(
+ *    [
+ *      {
+ *        type: "string",
+ *        name: "myString",
+ *      },
+ *      {
+ *        type: "uint256",
+ *        name: "myNumber",
+ *        indexed: true,
+ *      },
+ *      {
+ *        type: "uint8",
+ *        name: "mySmallNumber",
+ *        indexed: true,
+ *      },
+ *    ],
+ *    "0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000748656c6c6f252100000000000000000000000000000000000000000000000000",
+ *    [
+ *      "0x000000000000000000000000000000000000000000000000000000000000f310",
+ *      "0x0000000000000000000000000000000000000000000000000000000000000010",
+ *    ]
+ *  );
+ * > {
+ *  '0': 'Hello%!',
+ *  '1': 62224n,
+ *  '2': 16n,
+ *  __length__: 3,
+ *  myString: 'Hello%!',
+ *  myNumber: 62224n,
+ *  mySmallNumber: 16n
+ * }
+ * ```
+ */
+const decodeLog = (inputs, data, topics) => {
+    const clonedTopics = Array.isArray(topics) ? topics : [topics];
+    const indexedInputs = {};
+    const nonIndexedInputs = {};
+    for (const [i, input] of inputs.entries()) {
+        if (input.indexed) {
+            indexedInputs[i] = input;
+        }
+        else {
+            nonIndexedInputs[i] = input;
+        }
+    }
+    const decodedNonIndexedInputs = data
+        ? (0, parameters_api_js_1.decodeParametersWith)(Object.values(nonIndexedInputs), data, true)
+        : { __length__: 0 };
+    // If topics are more than indexed inputs, that means first topic is the event signature
+    const offset = clonedTopics.length - Object.keys(indexedInputs).length;
+    const decodedIndexedInputs = Object.values(indexedInputs).map((input, index) => STATIC_TYPES.some(s => input.type.startsWith(s))
+        ? _decodeParameter(input.type, clonedTopics[index + offset])
+        : clonedTopics[index + offset]);
+    const returnValues = { __length__: 0 };
+    let indexedCounter = 0;
+    let nonIndexedCounter = 0;
+    for (const [i, res] of inputs.entries()) {
+        returnValues[i] = res.type === 'string' ? '' : undefined;
+        if (indexedInputs[i]) {
+            returnValues[i] = decodedIndexedInputs[indexedCounter];
+            indexedCounter += 1;
+        }
+        if (nonIndexedInputs[i]) {
+            returnValues[i] = decodedNonIndexedInputs[String(nonIndexedCounter)];
+            nonIndexedCounter += 1;
+        }
+        if (res.name) {
+            returnValues[res.name] = returnValues[i];
+        }
+        returnValues.__length__ += 1;
+    }
+    return returnValues;
+};
+exports.decodeLog = decodeLog;
+//# sourceMappingURL=logs_api.js.map

package/lib/commonjs/api/logs_api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logs_api.js","sourceRoot":"","sources":["../../../src/api/logs_api.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;EAeE;;;AAQF,2DAA4E;AAE5E,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;AAErF,MAAM,gBAAgB,GAAG,CAAC,SAAiB,EAAE,WAAmB,EAAE,EAAE,CACnE,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAA,mCAAe,EAAC,SAAS,EAAE,WAAW,CAAC,CAAC;AAEhF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACI,MAAM,SAAS,GAAG,CACxB,MAAyD,EACzD,IAAe,EACf,MAAyB,EACxB,EAAE;IACH,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAE/D,MAAM,aAAa,GAAiC,EAAE,CAAC;IACvD,MAAM,gBAAgB,GAAiC,EAAE,CAAC;IAE1D,KAAK,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE;QAC1C,IAAI,KAAK,CAAC,OAAO,EAAE;YAClB,aAAa,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;SACzB;aAAM;YACN,gBAAgB,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;SAC5B;KACD;IAED,MAAM,uBAAuB,GAAkB,IAAI;QAClD,CAAC,CAAC,IAAA,wCAAoB,EAAC,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC;QACnE,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;IAErB,wFAAwF;IACxF,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC;IAEvE,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAC9E,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC/C,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,EAAE,YAAY,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC;QAC5D,CAAC,CAAC,YAAY,CAAC,KAAK,GAAG,MAAM,CAAC,CAC/B,CAAC;IAEF,MAAM,YAAY,GAAkB,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;IAEtD,IAAI,cAAc,GAAG,CAAC,CAAC;IACvB,IAAI,iBAAiB,GAAG,CAAC,CAAC;IAE1B,KAAK,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE;QACxC,YAAY,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAEzD,IAAI,aAAa,CAAC,CAAC,CAAC,EAAE;YACrB,YAAY,CAAC,CAAC,CAAC,GAAG,oBAAoB,CAAC,cAAc,CAAC,CAAC;YACvD,cAAc,IAAI,CAAC,CAAC;SACpB;QAED,IAAI,gBAAgB,CAAC,CAAC,CAAC,EAAE;YACxB,YAAY,CAAC,CAAC,CAAC,GAAG,uBAAuB,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;YACrE,iBAAiB,IAAI,CAAC,CAAC;SACvB;QAED,IAAI,GAAG,CAAC,IAAI,EAAE;YACb,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;SACzC;QAED,YAAY,CAAC,UAAU,IAAI,CAAC,CAAC;KAC7B;IAED,OAAO,YAA0B,CAAC;AACnC,CAAC,CAAC;AAzDW,QAAA,SAAS,aAyDpB"}