web-eth-abi 4.3.0

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

@@ -0,0 +1,238 @@
+import { AbiInput, HexString } from 'web3-types';
+export { encodeParameters, inferTypesAndEncodeParameters } from '../coders/encode.js';
+/**
+ * Encodes a parameter based on its type to its ABI representation.
+ * @param abi -  The type of the parameter. See the [Solidity documentation](https://docs.soliditylang.org/en/develop/types.html) for a list of types.
+ * @param param - The actual parameter to encode.
+ * @returns -  The ABI encoded parameter
+ * @example
+ * ```ts
+ *  const res = web3.eth.abi.encodeParameter("uint256", "2345675643");
+ *  console.log(res);
+ *  0x000000000000000000000000000000000000000000000000000000008bd02b7b
+ *
+ *  const res = web3.eth.abi.encodeParameter("uint", "2345675643");
+ *
+ *  console.log(res);
+ *  >0x000000000000000000000000000000000000000000000000000000008bd02b7b
+ *
+ *    const res = web3.eth.abi.encodeParameter("bytes32", "0xdf3234");
+ *
+ *  console.log(res);
+ *  >0xdf32340000000000000000000000000000000000000000000000000000000000
+ *
+ *   const res = web3.eth.abi.encodeParameter("bytes", "0xdf3234");
+ *
+ *  console.log(res);
+ *  > 0x00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000003df32340000000000000000000000000000000000000000000000000000000000
+ *
+ *   const res = web3.eth.abi.encodeParameter("bytes32[]", ["0xdf3234", "0xfdfd"]);
+ *
+ *  console.log(res);
+ *  > 0x00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000002df32340000000000000000000000000000000000000000000000000000000000fdfd000000000000000000000000000000000000000000000000000000000000
+ *
+ *  const res = web3.eth.abi.encodeParameter(
+ *    {
+ *      ParentStruct: {
+ *        propertyOne: "uint256",
+ *        propertyTwo: "uint256",
+ *        childStruct: {
+ *          propertyOne: "uint256",
+ *          propertyTwo: "uint256",
+ *        },
+ *      },
+ *    },
+ *    {
+ *      propertyOne: 42,
+ *      propertyTwo: 56,
+ *      childStruct: {
+ *        propertyOne: 45,
+ *        propertyTwo: 78,
+ *      },
+ *    }
+ *  );
+ *
+ *  console.log(res);
+ *  > 0x000000000000000000000000000000000000000000000000000000000000002a0000000000000000000000000000000000000000000000000000000000000038000000000000000000000000000000000000000000000000000000000000002d000000000000000000000000000000000000000000000000000000000000004e
+ * ```
+ */
+export declare const encodeParameter: (abi: AbiInput, param: unknown) => string;
+/**
+ * Should be used to decode list of params
+ */
+export declare const decodeParametersWith: (abis: AbiInput[] | ReadonlyArray<AbiInput>, bytes: HexString, loose: boolean) => {
+    [key: string]: unknown;
+    __length__: number;
+};
+/**
+ * Should be used to decode list of params
+ */
+/**
+ * Decodes ABI encoded parameters to its JavaScript types.
+ * @param abi -  An array of {@link AbiInput}. See the [Solidity documentation](https://docs.soliditylang.org/en/develop/types.html) for a list of types.
+ * @param bytes - The ABI byte code to decode
+ * @returns - The result object containing the decoded parameters.
+ * @example
+ * ```ts
+ * let res = web3.eth.abi.decodeParameters(
+ *    ["string", "uint256"],
+ *    "0x000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000ea000000000000000000000000000000000000000000000000000000000000000848656c6c6f212521000000000000000000000000000000000000000000000000"
+ *  );
+ *  console.log(res);
+ *  > { '0': 'Hello!%!', '1': 234n, __length__: 2 }
+ *
+ * let res = web3.eth.abi.decodeParameters(
+ *    [
+ *      {
+ *        type: "string",
+ *        name: "myString",
+ *      },
+ *      {
+ *        type: "uint256",
+ *        name: "myNumber",
+ *      },
+ *    ],
+ *    "0x000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000ea000000000000000000000000000000000000000000000000000000000000000848656c6c6f212521000000000000000000000000000000000000000000000000"
+ *  );
+ * console.log(res);
+ *  > {
+ *  '0': 'Hello!%!',
+ *  '1': 234n,
+ *  __length__: 2,
+ *  myString: 'Hello!%!',
+ *  myNumber: 234n
+ * }
+ *
+ * const res = web3.eth.abi.decodeParameters(
+ *    [
+ *      "uint8[]",
+ *      {
+ *        ParentStruct: {
+ *          propertyOne: "uint256",
+ *          propertyTwo: "uint256",
+ *          childStruct: {
+ *            propertyOne: "uint256",
+ *            propertyTwo: "uint256",
+ *          },
+ *        },
+ *      },
+ *    ],
+ *    "0x00000000000000000000000000000000000000000000000000000000000000a0000000000000000000000000000000000000000000000000000000000000002a0000000000000000000000000000000000000000000000000000000000000038000000000000000000000000000000000000000000000000000000000000002d000000000000000000000000000000000000000000000000000000000000004e0000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000002a0000000000000000000000000000000000000000000000000000000000000018"
+ *  );
+ *  console.log(res);
+ *  >
+ *  '0': [ 42n, 24n ],
+ *  '1': {
+ *    '0': 42n,
+ *    '1': 56n,
+ *    '2': {
+ *      '0': 45n,
+ *      '1': 78n,
+ *      __length__: 2,
+ *      propertyOne: 45n,
+ *      propertyTwo: 78n
+ *    },
+ *    __length__: 3,
+ *    propertyOne: 42n,
+ *    propertyTwo: 56n,
+ *    childStruct: {
+ *      '0': 45n,
+ *      '1': 78n,
+ *      __length__: 2,
+ *      propertyOne: 45n,
+ *      propertyTwo: 78n
+ *    }
+ *  },
+ *  __length__: 2,
+ *  ParentStruct: {
+ *    '0': 42n,
+ *    '1': 56n,
+ *    '2': {
+ *      '0': 45n,
+ *      '1': 78n,
+ *      __length__: 2,
+ *      propertyOne: 45n,
+ *      propertyTwo: 78n
+ *    },
+ *    __length__: 3,
+ *    propertyOne: 42n,
+ *    propertyTwo: 56n,
+ *    childStruct: {
+ *      '0': 45n,
+ *      '1': 78n,
+ *      __length__: 2,
+ *      propertyOne: 45n,
+ *      propertyTwo: 78n
+ *    }
+ *  }
+ *}
+ * ```
+ */
+export declare const decodeParameters: (abi: AbiInput[] | ReadonlyArray<AbiInput>, bytes: HexString) => {
+    [key: string]: unknown;
+    __length__: number;
+};
+/**
+ * Should be used to decode bytes to plain param
+ */
+/**
+ * Decodes an ABI encoded parameter to its JavaScript type.
+ * @param abi -  The type of the parameter. See the [Solidity documentation](https://docs.soliditylang.org/en/develop/types.html) for a list of types.
+ * @param bytes - The ABI byte code to decode
+ * @returns - The decoded parameter
+ * @example
+ * ```ts
+ *   const res = web3.eth.abi.decodeParameter(
+ *    "uint256",
+ *    "0x0000000000000000000000000000000000000000000000000000000000000010"
+ *  );
+ *  console.log(res);
+ * > 16n
+ *
+ *  const res = web3.eth.abi.decodeParameter(
+ *    "string",
+ *    "0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000848656c6c6f212521000000000000000000000000000000000000000000000000"
+ *  );
+ *
+ *  console.log(res);
+ *  > Hello!%!
+ *
+ *  const res = web3.eth.abi.decodeParameter(
+ *    {
+ *      ParentStruct: {
+ *        propertyOne: "uint256",
+ *        propertyTwo: "uint256",
+ *        childStruct: {
+ *          propertyOne: "uint256",
+ *          propertyTwo: "uint256",
+ *        },
+ *      },
+ *    },
+ *    "0x000000000000000000000000000000000000000000000000000000000000002a0000000000000000000000000000000000000000000000000000000000000038000000000000000000000000000000000000000000000000000000000000002d000000000000000000000000000000000000000000000000000000000000004e"
+ *  );
+ *
+ *  console.log(res);
+ *   {
+ *  '0': 42n,
+ *  '1': 56n,
+ *  '2': {
+ *    '0': 45n,
+ *    '1': 78n,
+ *    __length__: 2,
+ *    propertyOne: 45n,
+ *    propertyTwo: 78n
+ *  },
+ *  __length__: 3,
+ *  propertyOne: 42n,
+ *  propertyTwo: 56n,
+ *  childStruct: {
+ *    '0': 45n,
+ *    '1': 78n,
+ *    __length__: 2,
+ *    propertyOne: 45n,
+ *    propertyTwo: 78n
+ *  }
+ *}
+ * ```
+ */
+export declare const decodeParameter: (abi: AbiInput, bytes: HexString) => unknown;

package/lib/commonjs/api/parameters_api.js

@@ -0,0 +1,280 @@
+"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.decodeParameter = exports.decodeParameters = exports.decodeParametersWith = exports.encodeParameter = exports.inferTypesAndEncodeParameters = exports.encodeParameters = void 0;
+/**
+ *
+ *  @module ABI
+ */
+const web3_errors_1 = require("web3-errors");
+const decode_js_1 = require("../coders/decode.js");
+const encode_js_1 = require("../coders/encode.js");
+var encode_js_2 = require("../coders/encode.js");
+Object.defineProperty(exports, "encodeParameters", { enumerable: true, get: function () { return encode_js_2.encodeParameters; } });
+Object.defineProperty(exports, "inferTypesAndEncodeParameters", { enumerable: true, get: function () { return encode_js_2.inferTypesAndEncodeParameters; } });
+/**
+ * Encodes a parameter based on its type to its ABI representation.
+ * @param abi -  The type of the parameter. See the [Solidity documentation](https://docs.soliditylang.org/en/develop/types.html) for a list of types.
+ * @param param - The actual parameter to encode.
+ * @returns -  The ABI encoded parameter
+ * @example
+ * ```ts
+ *  const res = web3.eth.abi.encodeParameter("uint256", "2345675643");
+ *  console.log(res);
+ *  0x000000000000000000000000000000000000000000000000000000008bd02b7b
+ *
+ *  const res = web3.eth.abi.encodeParameter("uint", "2345675643");
+ *
+ *  console.log(res);
+ *  >0x000000000000000000000000000000000000000000000000000000008bd02b7b
+ *
+ *    const res = web3.eth.abi.encodeParameter("bytes32", "0xdf3234");
+ *
+ *  console.log(res);
+ *  >0xdf32340000000000000000000000000000000000000000000000000000000000
+ *
+ *   const res = web3.eth.abi.encodeParameter("bytes", "0xdf3234");
+ *
+ *  console.log(res);
+ *  > 0x00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000003df32340000000000000000000000000000000000000000000000000000000000
+ *
+ *   const res = web3.eth.abi.encodeParameter("bytes32[]", ["0xdf3234", "0xfdfd"]);
+ *
+ *  console.log(res);
+ *  > 0x00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000002df32340000000000000000000000000000000000000000000000000000000000fdfd000000000000000000000000000000000000000000000000000000000000
+ *
+ *  const res = web3.eth.abi.encodeParameter(
+ *    {
+ *      ParentStruct: {
+ *        propertyOne: "uint256",
+ *        propertyTwo: "uint256",
+ *        childStruct: {
+ *          propertyOne: "uint256",
+ *          propertyTwo: "uint256",
+ *        },
+ *      },
+ *    },
+ *    {
+ *      propertyOne: 42,
+ *      propertyTwo: 56,
+ *      childStruct: {
+ *        propertyOne: 45,
+ *        propertyTwo: 78,
+ *      },
+ *    }
+ *  );
+ *
+ *  console.log(res);
+ *  > 0x000000000000000000000000000000000000000000000000000000000000002a0000000000000000000000000000000000000000000000000000000000000038000000000000000000000000000000000000000000000000000000000000002d000000000000000000000000000000000000000000000000000000000000004e
+ * ```
+ */
+const encodeParameter = (abi, param) => (0, encode_js_1.encodeParameters)([abi], [param]);
+exports.encodeParameter = encodeParameter;
+/**
+ * Should be used to decode list of params
+ */
+const decodeParametersWith = (abis, bytes, loose) => {
+    try {
+        if (abis.length > 0 && (!bytes || bytes === '0x' || bytes === '0X')) {
+            throw new web3_errors_1.AbiError("Returned values aren't valid, did it run Out of Gas? " +
+                'You might also see this error if you are not using the ' +
+                'correct ABI for the contract you are retrieving data from, ' +
+                'requesting data from a block number that does not exist, ' +
+                'or querying a node which is not fully synced.');
+        }
+        return (0, decode_js_1.decodeParameters)(abis, `0x${bytes.replace(/0x/i, '')}`, loose);
+    }
+    catch (err) {
+        throw new web3_errors_1.AbiError(`Parameter decoding error: ${err.message}`, {
+            internalErr: err,
+        });
+    }
+};
+exports.decodeParametersWith = decodeParametersWith;
+/**
+ * Should be used to decode list of params
+ */
+/**
+ * Decodes ABI encoded parameters to its JavaScript types.
+ * @param abi -  An array of {@link AbiInput}. See the [Solidity documentation](https://docs.soliditylang.org/en/develop/types.html) for a list of types.
+ * @param bytes - The ABI byte code to decode
+ * @returns - The result object containing the decoded parameters.
+ * @example
+ * ```ts
+ * let res = web3.eth.abi.decodeParameters(
+ *    ["string", "uint256"],
+ *    "0x000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000ea000000000000000000000000000000000000000000000000000000000000000848656c6c6f212521000000000000000000000000000000000000000000000000"
+ *  );
+ *  console.log(res);
+ *  > { '0': 'Hello!%!', '1': 234n, __length__: 2 }
+ *
+ * let res = web3.eth.abi.decodeParameters(
+ *    [
+ *      {
+ *        type: "string",
+ *        name: "myString",
+ *      },
+ *      {
+ *        type: "uint256",
+ *        name: "myNumber",
+ *      },
+ *    ],
+ *    "0x000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000ea000000000000000000000000000000000000000000000000000000000000000848656c6c6f212521000000000000000000000000000000000000000000000000"
+ *  );
+ * console.log(res);
+ *  > {
+ *  '0': 'Hello!%!',
+ *  '1': 234n,
+ *  __length__: 2,
+ *  myString: 'Hello!%!',
+ *  myNumber: 234n
+ * }
+ *
+ * const res = web3.eth.abi.decodeParameters(
+ *    [
+ *      "uint8[]",
+ *      {
+ *        ParentStruct: {
+ *          propertyOne: "uint256",
+ *          propertyTwo: "uint256",
+ *          childStruct: {
+ *            propertyOne: "uint256",
+ *            propertyTwo: "uint256",
+ *          },
+ *        },
+ *      },
+ *    ],
+ *    "0x00000000000000000000000000000000000000000000000000000000000000a0000000000000000000000000000000000000000000000000000000000000002a0000000000000000000000000000000000000000000000000000000000000038000000000000000000000000000000000000000000000000000000000000002d000000000000000000000000000000000000000000000000000000000000004e0000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000002a0000000000000000000000000000000000000000000000000000000000000018"
+ *  );
+ *  console.log(res);
+ *  >
+ *  '0': [ 42n, 24n ],
+ *  '1': {
+ *    '0': 42n,
+ *    '1': 56n,
+ *    '2': {
+ *      '0': 45n,
+ *      '1': 78n,
+ *      __length__: 2,
+ *      propertyOne: 45n,
+ *      propertyTwo: 78n
+ *    },
+ *    __length__: 3,
+ *    propertyOne: 42n,
+ *    propertyTwo: 56n,
+ *    childStruct: {
+ *      '0': 45n,
+ *      '1': 78n,
+ *      __length__: 2,
+ *      propertyOne: 45n,
+ *      propertyTwo: 78n
+ *    }
+ *  },
+ *  __length__: 2,
+ *  ParentStruct: {
+ *    '0': 42n,
+ *    '1': 56n,
+ *    '2': {
+ *      '0': 45n,
+ *      '1': 78n,
+ *      __length__: 2,
+ *      propertyOne: 45n,
+ *      propertyTwo: 78n
+ *    },
+ *    __length__: 3,
+ *    propertyOne: 42n,
+ *    propertyTwo: 56n,
+ *    childStruct: {
+ *      '0': 45n,
+ *      '1': 78n,
+ *      __length__: 2,
+ *      propertyOne: 45n,
+ *      propertyTwo: 78n
+ *    }
+ *  }
+ *}
+ * ```
+ */
+const decodeParameters = (abi, bytes) => (0, exports.decodeParametersWith)(abi, bytes, false);
+exports.decodeParameters = decodeParameters;
+/**
+ * Should be used to decode bytes to plain param
+ */
+/**
+ * Decodes an ABI encoded parameter to its JavaScript type.
+ * @param abi -  The type of the parameter. See the [Solidity documentation](https://docs.soliditylang.org/en/develop/types.html) for a list of types.
+ * @param bytes - The ABI byte code to decode
+ * @returns - The decoded parameter
+ * @example
+ * ```ts
+ *   const res = web3.eth.abi.decodeParameter(
+ *    "uint256",
+ *    "0x0000000000000000000000000000000000000000000000000000000000000010"
+ *  );
+ *  console.log(res);
+ * > 16n
+ *
+ *  const res = web3.eth.abi.decodeParameter(
+ *    "string",
+ *    "0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000848656c6c6f212521000000000000000000000000000000000000000000000000"
+ *  );
+ *
+ *  console.log(res);
+ *  > Hello!%!
+ *
+ *  const res = web3.eth.abi.decodeParameter(
+ *    {
+ *      ParentStruct: {
+ *        propertyOne: "uint256",
+ *        propertyTwo: "uint256",
+ *        childStruct: {
+ *          propertyOne: "uint256",
+ *          propertyTwo: "uint256",
+ *        },
+ *      },
+ *    },
+ *    "0x000000000000000000000000000000000000000000000000000000000000002a0000000000000000000000000000000000000000000000000000000000000038000000000000000000000000000000000000000000000000000000000000002d000000000000000000000000000000000000000000000000000000000000004e"
+ *  );
+ *
+ *  console.log(res);
+ *   {
+ *  '0': 42n,
+ *  '1': 56n,
+ *  '2': {
+ *    '0': 45n,
+ *    '1': 78n,
+ *    __length__: 2,
+ *    propertyOne: 45n,
+ *    propertyTwo: 78n
+ *  },
+ *  __length__: 3,
+ *  propertyOne: 42n,
+ *  propertyTwo: 56n,
+ *  childStruct: {
+ *    '0': 45n,
+ *    '1': 78n,
+ *    __length__: 2,
+ *    propertyOne: 45n,
+ *    propertyTwo: 78n
+ *  }
+ *}
+ * ```
+ */
+const decodeParameter = (abi, bytes) => (0, exports.decodeParameters)([abi], bytes)['0'];
+exports.decodeParameter = decodeParameter;
+//# sourceMappingURL=parameters_api.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"parameters_api.js","sourceRoot":"","sources":["../../../src/api/parameters_api.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;EAeE;;;AAEF;;;GAGG;AAEH,6CAAuC;AAEvC,mDAAmF;AACnF,mDAAuD;AAEvD,iDAAsF;AAA7E,6GAAA,gBAAgB,OAAA;AAAE,0HAAA,6BAA6B,OAAA;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACI,MAAM,eAAe,GAAG,CAAC,GAAa,EAAE,KAAc,EAAU,EAAE,CACxE,IAAA,4BAAgB,EAAC,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;AADrB,QAAA,eAAe,mBACM;AAClC;;GAEG;AACI,MAAM,oBAAoB,GAAG,CACnC,IAA0C,EAC1C,KAAgB,EAChB,KAAc,EACmC,EAAE;IACnD,IAAI;QACH,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,IAAI,CAAC,EAAE;YACpE,MAAM,IAAI,sBAAQ,CACjB,uDAAuD;gBACtD,yDAAyD;gBACzD,6DAA6D;gBAC7D,2DAA2D;gBAC3D,+CAA+C,CAChD,CAAC;SACF;QACD,OAAO,IAAA,4BAAwB,EAAC,IAAI,EAAE,KAAK,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;KAC9E;IAAC,OAAO,GAAG,EAAE;QACb,MAAM,IAAI,sBAAQ,CAAC,6BAA8B,GAAa,CAAC,OAAO,EAAE,EAAE;YACzE,WAAW,EAAE,GAAG;SAChB,CAAC,CAAC;KACH;AACF,CAAC,CAAC;AArBW,QAAA,oBAAoB,wBAqB/B;AAEF;;GAEG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoGG;AACI,MAAM,gBAAgB,GAAG,CAC/B,GAAyC,EACzC,KAAgB,EACiC,EAAE,CAAC,IAAA,4BAAoB,EAAC,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AAHhF,QAAA,gBAAgB,oBAGgE;AAE7F;;GAEG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2DG;AACI,MAAM,eAAe,GAAG,CAAC,GAAa,EAAE,KAAgB,EAAW,EAAE,CAC3E,IAAA,wBAAgB,EAAC,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC;AADxB,QAAA,eAAe,mBACS"}

package/lib/commonjs/coders/base/address.d.ts

@@ -0,0 +1,4 @@
+import { AbiParameter } from 'web3-types';
+import { DecoderResult, EncoderResult } from '../types.js';
+export declare function encodeAddress(param: AbiParameter, input: unknown): EncoderResult;
+export declare function decodeAddress(_param: AbiParameter, bytes: Uint8Array): DecoderResult<string>;

package/lib/commonjs/coders/base/address.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decodeAddress = exports.encodeAddress = void 0;
+/*
+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/>.
+*/
+const web3_errors_1 = require("web3-errors");
+const web3_utils_1 = require("web3-utils");
+const web3_validator_1 = require("web3-validator");
+const utils_js_1 = require("../utils.js");
+const ADDRESS_BYTES_COUNT = 20;
+const ADDRESS_OFFSET = utils_js_1.WORD_SIZE - ADDRESS_BYTES_COUNT;
+function encodeAddress(param, input) {
+    if (typeof input !== 'string') {
+        throw new web3_errors_1.AbiError('address type expects string as input type', {
+            value: input,
+            name: param.name,
+            type: param.type,
+        });
+    }
+    let address = input.toLowerCase();
+    if (!address.startsWith('0x')) {
+        address = `0x${address}`;
+    }
+    if (!(0, web3_validator_1.isAddress)(address)) {
+        throw new web3_errors_1.AbiError('provided input is not valid address', {
+            value: input,
+            name: param.name,
+            type: param.type,
+        });
+    }
+    // for better performance, we could convert hex to destination bytes directly (encoded var)
+    const addressBytes = web3_validator_1.utils.hexToUint8Array(address);
+    // expand address to WORD_SIZE
+    const encoded = (0, utils_js_1.alloc)(utils_js_1.WORD_SIZE);
+    encoded.set(addressBytes, ADDRESS_OFFSET);
+    return {
+        dynamic: false,
+        encoded,
+    };
+}
+exports.encodeAddress = encodeAddress;
+function decodeAddress(_param, bytes) {
+    const addressBytes = bytes.subarray(ADDRESS_OFFSET, utils_js_1.WORD_SIZE);
+    if (addressBytes.length !== ADDRESS_BYTES_COUNT) {
+        throw new web3_errors_1.AbiError('Invalid decoding input, not enough bytes to decode address', { bytes });
+    }
+    const result = web3_validator_1.utils.uint8ArrayToHexString(addressBytes);
+    // should we check is decoded value is valid address?
+    // if(!isAddress(result)) {
+    //     throw new AbiError("encoded data is not valid address", {
+    //         address: result,
+    //     });
+    // }
+    return {
+        result: (0, web3_utils_1.toChecksumAddress)(result),
+        encoded: bytes.subarray(utils_js_1.WORD_SIZE),
+        consumed: utils_js_1.WORD_SIZE,
+    };
+}
+exports.decodeAddress = decodeAddress;
+//# sourceMappingURL=address.js.map

package/lib/commonjs/coders/base/address.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"address.js","sourceRoot":"","sources":["../../../../src/coders/base/address.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;EAeE;AACF,6CAAuC;AAEvC,2CAA+C;AAC/C,mDAAkD;AAElD,0CAA+C;AAE/C,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,cAAc,GAAG,oBAAS,GAAG,mBAAmB,CAAC;AAEvD,SAAgB,aAAa,CAAC,KAAmB,EAAE,KAAc;IAChE,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC9B,MAAM,IAAI,sBAAQ,CAAC,2CAA2C,EAAE;YAC/D,KAAK,EAAE,KAAK;YACZ,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,IAAI,EAAE,KAAK,CAAC,IAAI;SAChB,CAAC,CAAC;KACH;IACD,IAAI,OAAO,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;IAClC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;QAC9B,OAAO,GAAG,KAAK,OAAO,EAAE,CAAC;KACzB;IACD,IAAI,CAAC,IAAA,0BAAS,EAAC,OAAO,CAAC,EAAE;QACxB,MAAM,IAAI,sBAAQ,CAAC,qCAAqC,EAAE;YACzD,KAAK,EAAE,KAAK;YACZ,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,IAAI,EAAE,KAAK,CAAC,IAAI;SAChB,CAAC,CAAC;KACH;IACD,2FAA2F;IAC3F,MAAM,YAAY,GAAG,sBAAK,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IACpD,8BAA8B;IAC9B,MAAM,OAAO,GAAG,IAAA,gBAAK,EAAC,oBAAS,CAAC,CAAC;IACjC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;IAC1C,OAAO;QACN,OAAO,EAAE,KAAK;QACd,OAAO;KACP,CAAC;AACH,CAAC;AA5BD,sCA4BC;AAED,SAAgB,aAAa,CAAC,MAAoB,EAAE,KAAiB;IACpE,MAAM,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC,cAAc,EAAE,oBAAS,CAAC,CAAC;IAC/D,IAAI,YAAY,CAAC,MAAM,KAAK,mBAAmB,EAAE;QAChD,MAAM,IAAI,sBAAQ,CAAC,4DAA4D,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;KAC5F;IACD,MAAM,MAAM,GAAG,sBAAK,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;IAEzD,qDAAqD;IACrD,2BAA2B;IAC3B,gEAAgE;IAChE,2BAA2B;IAC3B,UAAU;IACV,IAAI;IACJ,OAAO;QACN,MAAM,EAAE,IAAA,8BAAiB,EAAC,MAAM,CAAC;QACjC,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,oBAAS,CAAC;QAClC,QAAQ,EAAE,oBAAS;KACnB,CAAC;AACH,CAAC;AAlBD,sCAkBC"}

package/lib/commonjs/coders/base/array.d.ts

@@ -0,0 +1,4 @@
+import { AbiParameter } from 'web3-types';
+import { DecoderResult, EncoderResult } from '../types.js';
+export declare function encodeArray(param: AbiParameter, values: unknown): EncoderResult;
+export declare function decodeArray(param: AbiParameter, bytes: Uint8Array): DecoderResult<unknown[]>;