Merge pull request #652 from tronprotocol/release/v6.0.4

Release/v6.0.4

Author: unicornonea

.gitignore

@@ -13,4 +13,4 @@ test/lib/dist/
 /lib/
 !src/lib
 !test/lib
-
+.nyc_output/

CHANGELOG.md

@@ -1,6 +1,25 @@
 Change Log
 =========
 
+__6.0.4__
+
+## New Features
+- Improve type inference in `Contract` module when using typescript.
+    - The `Contract` now infers method signatures based on the provided ABI.
+    - To enable accurate inference, the ABI should be defined using the `as const` assertion or passed directly into tronWeb.contract().
+
+## Change
+- Change the return behavior of the `contract.new()` method.
+    - Previously, this method mutated the current instance and used the ABI stored on the Tron blockchain, which proved to be unreliable. It now returns a new instance that uses the ABI provided in the options parameter.
+- Export `GetEventResultOptions` and `EventResponse`.
+- Allow using length as the value of the name field in the ABI, but you cannot use `result['length']` to read its value.
+- Bump `axios` from 1.8.3 to 1.11.0, bump `eslint` from 9.22.0 to 9.31.0.
+
+## Bug Fixes
+- Fix the issue where `addUpdateData` treats numeric strings as numbers.[#629](https://github.com/tronprotocol/tronweb/issues/629)
+    - Starting from TronWeb v6.0.4, `addUpdateData` will use `TronWeb.fromUtf8` to convert the provided data string—unless it starts with '0x'.
+    - If the resulting data string has an odd length, a '0' will be prepended to ensure even length.
+
 __6.0.3__
 - Add support for deserializing 6 more transactions.
 - Fix npm audit issues.

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "tronweb",
-    "version": "6.0.3",
+    "version": "6.0.4",
     "description": "JavaScript SDK that encapsulates the TRON HTTP API",
     "main": "./lib/commonjs/index.js",
     "module": "./lib/esm/index.js",
@@ -45,7 +45,7 @@
         "testTx": "node scripts/test-node.js && node test/helpers/newAccounts 100 && npx mocha 'test/**/transaction.test.js' --timeout 120000",
         "test-no-accounts": "node scripts/test-node.js && npx mocha 'test/**/*.test.js'",
         "test:browser": "npm run-script newaccount && node scripts/test-browser.js && npx karma start --single-run --browsers ChromeHeadless",
-        "coverage": "npm run-script test:browser && npm run-script test",
+        "coverage": "npm run build:test && npm run-script newaccount && nyc mocha 'lib/commonjs/test/**/*.test.js' --timeout 120000",
         "btest": "npm run build:dev && npm run test",
         "format-all": "prettier --write ./src",
         "lint": "eslint src",
@@ -58,7 +58,7 @@
     },
     "dependencies": {
         "@babel/runtime": "7.26.10",
-        "axios": "1.8.3",
+        "axios": "1.11.0",
         "bignumber.js": "9.1.2",
         "ethereum-cryptography": "2.2.1",
         "ethers": "6.13.5",
@@ -95,14 +95,13 @@
         "buffer": "6.0.3",
         "chai": "4.5.0",
         "chalk": "2.4.2",
-        "eslint": "9.22.0",
+        "eslint": "9.31.0",
         "eslint-config-prettier": "10.1.1",
         "eslint-import-resolver-typescript": "4.2.0",
         "events": "3.3.0",
         "globals": "16.0.0",
         "globby": "14.1.0",
         "husky": "9.1.7",
-        "istanbul": "0.4.5",
         "json-schema": "0.4.0",
         "jsonwebtoken": "9.0.2",
         "karma": "6.4.4",
@@ -116,6 +115,7 @@
         "karma-spec-reporter": "0.0.36",
         "karma-webpack": "5.0.1",
         "mocha": "11.1.0",
+        "nyc": "17.1.0",
         "prettier": "3.5.3",
         "puppeteer": "24.4.0",
         "querystring-es3": "0.2.1",

package.json

@@ -5,7 +5,7 @@ import { encodeParamsV2ByABI } from '../../utils/abi.js';
 import { CreateSmartContractTransaction, SignedTransaction, Transaction, TransactionWrapper } from '../../types/Transaction.js';
 import { Validator } from '../../paramValidator/index.js';
 import { GetSignWeightResponse } from '../../types/APIResponse.js';
-import { isArray, isInteger, isNotNullOrUndefined, isObject, isString } from '../../utils/validations.js';
+import { isArray, isHex, isInteger, isNotNullOrUndefined, isObject, isString } from '../../utils/validations.js';
 import {
     AccountCreateContract,
     AccountPermissionUpdateContract,
@@ -2159,7 +2159,7 @@ export class TransactionBuilder {
                 delete _ownerPermissions.type;
             }
             _ownerPermissions.keys = _ownerPermissions.keys?.map(({ address, weight }) => ({
-                address: this.tronWeb.address.toHex(address),
+                address: toHex(address),
                 weight,
             }));
             data.owner = _ownerPermissions as Permission;
@@ -2171,7 +2171,7 @@ export class TransactionBuilder {
             // @ts-ignore
             _witnessPermissions.type = 'Witness';
             _witnessPermissions.keys = _witnessPermissions.keys.map(({ address, weight }) => ({
-                address: this.tronWeb.address.toHex(address),
+                address: toHex(address),
                 weight,
             }));
             data.witness = _witnessPermissions;
@@ -2186,7 +2186,7 @@ export class TransactionBuilder {
             });
             _activesPermissions.forEach((_activesPermission) => {
                 _activesPermission.keys = _activesPermission.keys.map(({ address, weight }) => ({
-                    address: this.tronWeb.address.toHex(address),
+                    address: toHex(address),
                     weight,
                 }));
             });
@@ -2246,8 +2246,10 @@ export class TransactionBuilder {
         if (Reflect.has(transaction, 'signature')) throw new Error('You can not extend the expiration of a signed transaction.');
 
         if (options.data) {
-            if (options.dataFormat !== 'hex') options.data = TronWeb.toHex(options.data);
-            options.data = options.data!.replace(/^0x/, '');
+            if (options.dataFormat !== 'hex' && !/^0x/.test(options.data)) options.data = TronWeb.fromUtf8(options.data);
+            if (!isHex(options.data)) throw new Error('Invalid data provided');
+            options.data = options.data.replace(/^0x/, '');
+            options.data = options.data.padStart(Math.ceil(options.data.length/2)*2, '0');
             if (options.data.length === 0) throw new Error('Invalid data provided');
             transaction.raw_data.data = options.data;
         }

src/lib/TransactionBuilder/TransactionBuilder.ts

@@ -1,25 +1,24 @@
 import { TronWeb } from '../../tronweb.js';
 import utils from '../../utils/index.js';
 import { Method, AbiFragmentNoErrConstructor } from './method.js';
-import type { ContractAbiInterface } from '../../types/ABI.js';
-import { Address } from '../../types/Trx.js';
-import { CreateSmartContractOptions } from '../../types/TransactionBuilder.js';
+import type { ContractAbiInterface, GetMethodsTypeFromAbi, GetOnMethodTypeFromAbi, AnyOnMethodType } from '../../types/ABI.js';
+import type { Address } from '../../types/Trx.js';
+import type { CreateSmartContractOptions } from '../../types/TransactionBuilder.js';
 
-
-export class Contract {
+export class Contract<Abi extends ContractAbiInterface = ContractAbiInterface> {
     tronWeb: TronWeb;
-    abi: ContractAbiInterface;
+    abi: Abi;
     address: false | string;
     eventListener: any;
     bytecode?: false | string;
     deployed?: boolean;
     lastBlock?: false | number;
-    methods: Record<string | number | symbol, (...args: any) => ReturnType<Method['onMethod']>>;
-    methodInstances: Record<string | number | symbol, Method>;
+    methods: GetOnMethodTypeFromAbi<Abi> & AnyOnMethodType;
+    methodInstances: GetMethodsTypeFromAbi<Abi>;
     props: any[];
     [key: string | number | symbol]: any;
 
-    constructor(tronWeb: TronWeb, abi: ContractAbiInterface = [], address: Address) {
+    constructor(tronWeb: TronWeb, abi: Abi = [] as any, address: Address) {
         if (!tronWeb || !(tronWeb instanceof TronWeb)) throw new Error('Expected instance of TronWeb');
 
         this.tronWeb = tronWeb;
@@ -32,8 +31,8 @@ export class Contract {
         this.deployed = false;
         this.lastBlock = false;
 
-        this.methods = {};
-        this.methodInstances = {};
+        this.methods = {} as GetOnMethodTypeFromAbi<Abi> & AnyOnMethodType;
+        this.methodInstances = {} as GetMethodsTypeFromAbi<Abi>;
         this.props = [];
 
         if (utils.address.isAddress(address)) {
@@ -50,29 +49,31 @@ export class Contract {
         return this.hasOwnProperty(property) || (this as any).__proto__.hasOwnProperty(property);
     }
 
-    loadAbi(abi: ContractAbiInterface) {
+    loadAbi(abi: Abi) {
         this.abi = abi;
-        this.methods = {};
+        this.methods = {} as GetOnMethodTypeFromAbi<Abi> & AnyOnMethodType;
 
         this.props.forEach((prop: string) => delete (this as any)[prop]);
 
         abi.forEach((func) => {
             // Don't build a method for constructor function. That's handled through contract create.
             // Don't build a method for error function.
-            if (!func.type || /constructor|error/i.test(func.type)) return;
-
-            const method = new Method(this, func as AbiFragmentNoErrConstructor);
+            if (!func.type || ['constructor', 'error'].includes(func.type.toLowerCase())) return;
+            const method = new Method<any>(this, func as AbiFragmentNoErrConstructor) as GetMethodsTypeFromAbi<Abi>[keyof GetMethodsTypeFromAbi<Abi>];
             const methodCall = method.onMethod.bind(method);
 
             const { name, functionSelector, signature } = method;
+            const internalName = name as keyof GetMethodsTypeFromAbi<Abi>;
+            const internalFunctionSelector = functionSelector as keyof GetMethodsTypeFromAbi<Abi>;
+            const internalSignature = signature as keyof GetMethodsTypeFromAbi<Abi>;
 
-            this.methods[name] = methodCall;
-            this.methods[functionSelector!] = methodCall;
-            this.methods[signature] = methodCall;
+            (this.methods as AnyOnMethodType)[name] = methodCall;
+            (this.methods as AnyOnMethodType)[functionSelector!] = methodCall;
+            (this.methods as AnyOnMethodType)[signature] = methodCall;
 
-            this.methodInstances[name] = method;
-            this.methodInstances[functionSelector!] = method;
-            this.methodInstances[signature] = method;
+            this.methodInstances[internalName] = method;
+            this.methodInstances[internalFunctionSelector!] = method;
+            this.methodInstances[internalSignature] = method;
 
             if (!this.hasProperty(name)) {
                 (this as any)[name] = methodCall;
@@ -119,7 +120,8 @@ export class Contract {
         }
 
         await utils.sleep(3000);
-        return this.at(signedTransaction.contract_address);
+        const abi = signedTransaction.raw_data.contract[0].parameter.value.new_contract.abi.entrys || [];
+        return this.tronWeb.contract(abi, signedTransaction.contract_address);
     }
 
     async at(contractAddress: Address) {