Merge pull request #709 from tronprotocol/release/v6.4.0

Release/v6.4.0

Author: unicornonea

CHANGELOG.md

@@ -1,6 +1,45 @@
 Change Log
 =========
 
+__6.4.0__
+
+## New Features
+
+- Typed `read` / `write` contract namespaces
+
+  Added contract.read and contract.write namespaces for type-safe, ergonomic access to contract methods. Functions are split by state mutability: view / pure (constant call) functions are exposed under contract.read, while state-changing functions are exposed under contract.write. When an ABI is declared as const, function names and argument types are checked at compile time.
+
+  - Call as contract.read.methodName([arg0, arg1, ...], options) / contract.write.methodName([arg0, arg1, ...], options).
+  - The write `account` option is a private key: its derived address owns and signs the transaction, so a write can be issued from a non-default signer — including on an instance with no default key. A value that is not a private key is rejected. Treat this value as secret. For reads, a `from` option sets the caller address directly (validated as an address).
+  - Validation errors (argument count, signer, call value, account) are surfaced as promise rejections.
+  - ABI functions literally named read or write remain callable via the legacy flat surface (handled through a proxy).
+  - Each function is additionally exposed under its full selector, e.g. contract.read['balanceOf(address)'] / contract.write['transfer(address,uint256)']. The selector form pins that exact overload, so same-arity overloads can be addressed unambiguously. Note: namespaces now enumerate each method under both its bare name and its selector, so Object.keys / for…in over contract.read / contract.write return two entries per function.
+
+- Added `utils.abi.encodeFunctionData`
+
+  Added utils.abi.encodeFunctionData(funcABI, args) to build smart contract calldata (function selector + encoded parameters). Validates argument count and supports TRON-specific handling of trcToken (kept in the selector, encoded as `uint256`).
+
+- Added `transactionBuilder.updateWitness`
+
+  Added transactionBuilder.updateWitness(address, url, options) to create a WitnessUpdateContract transaction that updates a witness node URL. Validates the address and the URL format / length (≤ 256).
+
+## Improvements
+
+- Dropped `Buffer` in favor of `TextEncoder` / `TextDecoder`
+
+  Replaced Buffer`-based encoding in `tronweb, utils/crypto, utils/abi and utils/ethersUtils with TextEncoder / TextDecoder for better cross-environment (browser) compatibility. The conversion is byte-for-byte equivalent to the previous behavior.
+
+- `address.fromPrivateKey` accepts `0x`-prefixed private keys
+
+  TronWeb.address.fromPrivateKey now strips a leading 0x from the private key before deriving the address, so a private key works whether or not it carries the 0x prefix.
+
+## Changes
+
+- Bump axios from 1.15.0 to 1.18.0.
+- Bump dev dependency nyc to 18.
+- Add overrides for ws (8.21.0) and serialize-javascript (7.0.5) to pin security-patched versions.
+- build now runs the full build:all (esm, cjs, dist).
+
 __6.3.0__
 
 ## New Features

README.md

@@ -202,7 +202,7 @@ In order to contribute you can
 * run the tests — `npm run test`
 * push your changes and open a pull request
 
-Contact the team at https://cn.developers.tron.network/docs/online-technical-support
+Contact the team at [here](https://developers.tron.network/docs/online-technical-support)
 
 
 ## Licence

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "tronweb",
-    "version": "6.3.0",
+    "version": "6.4.0",
     "description": "JavaScript SDK that encapsulates the TRON HTTP API",
     "main": "./lib/commonjs/index.js",
     "module": "./lib/esm/index.js",
@@ -41,7 +41,7 @@
         "copy-protocol:cjs": "cp -R ./src/protocol ./lib/commonjs/",
         "copy-protocol:esm": "cp -R ./src/protocol ./lib/esm/",
         "prepare": "npm run build",
-        "build": "npm run clean && webpack --config webpack.config.js --progress --color",
+        "build": "npm run build:all",
         "build:dev": "NODE_ENV=development npm run build",
         "clean:all": "rimraf dist lib",
         "clean": "rimraf dist",
@@ -60,7 +60,7 @@
     },
     "dependencies": {
         "@babel/runtime": "7.26.10",
-        "axios": "1.15.0",
+        "axios": "1.18.0",
         "bignumber.js": "9.1.2",
         "ethereum-cryptography": "2.2.1",
         "ethers": "6.13.5",
@@ -70,7 +70,7 @@
         "validator": "13.15.23"
     },
     "devDependencies": {
-        "@babel/core": "7.26.10",
+        "@babel/core": "7.29.7",
         "@babel/plugin-transform-class-properties": "7.25.9",
         "@babel/plugin-transform-numeric-separator": "7.25.9",
         "@babel/plugin-transform-object-rest-spread": "7.25.9",
@@ -92,7 +92,6 @@
         "babel-loader": "10.0.0",
         "babel-plugin-istanbul": "7.0.0",
         "babel-plugin-source-map-support": "2.2.0",
-        "buffer": "6.0.3",
         "chai": "4.5.0",
         "chalk": "2.4.2",
         "eslint": "9.31.0",
@@ -113,7 +112,7 @@
         "karma-spec-reporter": "0.0.36",
         "karma-webpack": "5.0.1",
         "mocha": "11.1.0",
-        "nyc": "17.1.0",
+        "nyc": "18.0.0",
         "prettier": "3.5.3",
         "puppeteer": "24.23.0",
         "querystring-es3": "0.2.1",
@@ -133,6 +132,8 @@
     "license": "MIT",
     "repository": "https://github.com/tronprotocol/tronweb.git",
     "overrides": {
+        "js-yaml": "4.2.0",
+        "ws": "8.21.0",
         "serialize-javascript": "7.0.5"
     }
 }

package.json

@@ -45,6 +45,7 @@ import {
     WithdrawBalanceContract,
     WithdrawExpireUnfreezeContract,
     WitnessCreateContract,
+    WitnessUpdateContract,
 } from '../../types/Contract.js';
 import {
     createTransaction,
@@ -686,6 +687,47 @@ export class TransactionBuilder {
         );
     }
 
+    async updateWitness(
+        address: string = this.tronWeb.defaultAddress.hex as string,
+        url = '',
+        options: TransactionCommonOptions = {}
+    ): Promise<Transaction<WitnessUpdateContract>> {
+        this.validator.notValid([
+            {
+                name: 'origin',
+                type: 'address',
+                value: address,
+            },
+            {
+                name: 'url',
+                type: 'url',
+                value: url as string,
+                msg: 'Invalid url provided',
+            },
+            {
+                name: 'url',
+                type: 'string',
+                value: url as string,
+                lte: 256,
+                msg: 'Invalid url provided',
+            },
+        ]);
+
+        const data: WitnessUpdateContract = {
+            owner_address: toHex(address as string),
+            update_url: fromUtf8(url as string),
+        };
+
+        const transactionOptions = getTransactionOptions(options);
+        return createTransaction<WitnessUpdateContract>(
+            this.tronWeb,
+            ContractType.WitnessUpdateContract,
+            data,
+            options?.permissionId,
+            transactionOptions
+        );
+    }
+
     async vote(
         votes: VoteInfo = {},
         voterAddress: string = this.tronWeb.defaultAddress.hex as string,
@@ -1248,7 +1290,7 @@ export class TransactionBuilder {
         );
 
         if (args.function_selector) {
-            args.data = keccak256(Buffer.from(args.function_selector, 'utf-8')).toString().substring(2, 10) + args.parameter;
+            args.data = keccak256(new TextEncoder().encode(args.function_selector)).toString().substring(2, 10) + args.parameter;
         }
         const value: TriggerSmartContract = {
             data: args.data,

src/lib/TransactionBuilder/TransactionBuilder.ts

@@ -2,6 +2,7 @@ import { TronWeb } from '../../tronweb.js';
 import { Transaction, TransactionWrapper } from '../../types/Transaction.js';
 import { txCheckWithArgs, txJsonToPb, txPbToTxID, txPbToRawDataHex } from '../../utils/transaction.js';
 import { keccak256 } from '../../utils/ethersUtils.js';
+import { hexStr2byteArray } from '../../utils/code.js';
 import { ContractParamter, ContractType } from '../../types/Contract.js';
 import { TriggerConstantContractOptions } from '../../types/TransactionBuilder.js';
 
@@ -50,7 +51,7 @@ export function resultManagerTriggerSmartContract(
 export function genContractAddress(ownerAddress: string, txID: string) {
     return (
         '41' +
-        keccak256(Buffer.from(txID + ownerAddress, 'hex'))
+        keccak256(new Uint8Array(hexStr2byteArray(txID + ownerAddress)))
             .toString()
             .substring(2)
             .slice(24)

src/lib/TransactionBuilder/helper.ts

@@ -1,10 +1,26 @@
 import { TronWeb } from '../../tronweb.js';
 import utils from '../../utils/index.js';
 import { Method, AbiFragmentNoErrConstructor } from './method.js';
+import { buildReadNamespace, buildWriteNamespace } from './readWrite.js';
+import type { ContractReadNamespace, ContractWriteNamespace } from './readWrite.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';
 
+// When the ABI itself defines a function named `read`/`write`, the legacy flat
+// call surface must stay reachable as `contract.read(...)`/`contract.write(...)`.
+// Wrap the legacy call in a Proxy whose property access and enumeration are
+// served entirely by the namespace, so both surfaces share the one getter.
+function wrapReservedNamespace<T extends object>(namespace: T, legacyCall: unknown): T {
+    if (typeof legacyCall !== 'function') return namespace;
+    return new Proxy(legacyCall, {
+        get: (_target, prop) => namespace[prop as keyof T],
+        has: (_target, prop) => prop in namespace,
+        ownKeys: () => Reflect.ownKeys(namespace),
+        getOwnPropertyDescriptor: (_target, prop) => Object.getOwnPropertyDescriptor(namespace, prop),
+    }) as T;
+}
+
 export class Contract<Abi extends ContractAbiInterface = ContractAbiInterface> {
     tronWeb: TronWeb;
     abi: Abi;
@@ -16,6 +32,8 @@ export class Contract<Abi extends ContractAbiInterface = ContractAbiInterface> {
     methods: GetOnMethodTypeFromAbi<Abi> & AnyOnMethodType;
     methodInstances: GetMethodsTypeFromAbi<Abi>;
     props: any[];
+    private _readNamespace?: { abi: Abi; namespace: ContractReadNamespace<Abi> };
+    private _writeNamespace?: { abi: Abi; namespace: ContractWriteNamespace<Abi> };
     [key: string | number | symbol]: any;
 
     constructor(tronWeb: TronWeb, abi: Abi = [] as any, address: Address) {
@@ -31,8 +49,8 @@ export class Contract<Abi extends ContractAbiInterface = ContractAbiInterface> {
         this.deployed = false;
         this.lastBlock = false;
 
-        this.methods = {} as GetOnMethodTypeFromAbi<Abi> & AnyOnMethodType;
-        this.methodInstances = {} as GetMethodsTypeFromAbi<Abi>;
+        this.methods = Object.create(null) as GetOnMethodTypeFromAbi<Abi> & AnyOnMethodType;
+        this.methodInstances = Object.create(null) as GetMethodsTypeFromAbi<Abi>;
         this.props = [];
 
         if (utils.address.isAddress(address)) {
@@ -44,14 +62,54 @@ export class Contract<Abi extends ContractAbiInterface = ContractAbiInterface> {
         this.loadAbi(abi);
     }
 
+    /**
+     * Type-safe read namespace:
+     * every `view`/`pure` ABI function is callable as
+     * `contract.read.fn([args], { from, value })` and resolves to the decoded
+     * result directly. Rebuilt lazily whenever the contract ABI is replaced.
+     */
+    get read(): ContractReadNamespace<Abi> {
+        if (!this._readNamespace || this._readNamespace.abi !== this.abi) {
+            this._readNamespace = {
+                abi: this.abi,
+                namespace: wrapReservedNamespace(
+                    buildReadNamespace(this) as object,
+                    this.methods['read']
+                ) as ContractReadNamespace<Abi>,
+            };
+        }
+        return this._readNamespace.namespace;
+    }
+
+    /**
+     * Type-safe write namespace:
+     * every state-changing ABI function is callable as
+     * `contract.write.fn([args], { account, value, feeLimit, tokenId, tokenValue, permissionId })`,
+     * signed with the instance's default private key, broadcast, and resolved to
+     * the transaction ID. Rebuilt lazily whenever the contract ABI is replaced.
+     */
+    get write(): ContractWriteNamespace<Abi> {
+        if (!this._writeNamespace || this._writeNamespace.abi !== this.abi) {
+            this._writeNamespace = {
+                abi: this.abi,
+                namespace: wrapReservedNamespace(
+                    buildWriteNamespace(this) as object,
+                    this.methods['write']
+                ) as ContractWriteNamespace<Abi>,
+            };
+        }
+        return this._writeNamespace.namespace;
+    }
+
     hasProperty(property: number | string | symbol) {
         // eslint-disable-next-line no-prototype-builtins
         return this.hasOwnProperty(property) || (this as any).__proto__.hasOwnProperty(property);
     }
 
     loadAbi(abi: Abi) {
         this.abi = abi;
-        this.methods = {} as GetOnMethodTypeFromAbi<Abi> & AnyOnMethodType;
+        this.methods = Object.create(null) as GetOnMethodTypeFromAbi<Abi> & AnyOnMethodType;
+        this.methodInstances = Object.create(null) as GetMethodsTypeFromAbi<Abi>;
 
         this.props.forEach((prop: string) => delete (this as any)[prop]);
 
@@ -151,3 +209,17 @@ export class Contract<Abi extends ContractAbiInterface = ContractAbiInterface> {
 
 export type { CallOptions, SendOptions, AbiFragmentNoErrConstructor } from './method.js';
 export { Method } from './method.js';
+export type {
+    ContractReadNamespace,
+    ContractWriteNamespace,
+    ReadContractFunctionName,
+    WriteContractFunctionName,
+    ReadContractParameters,
+    ReadContractReturnType,
+    WriteContractParameters,
+    WriteContractReturnType,
+    ReadOptions,
+    WriteOptions,
+    CollapseSingleItemTuple,
+} from './readWrite.js';
+export { buildReadNamespace, buildWriteNamespace } from './readWrite.js';

src/lib/contract/index.ts

@@ -90,7 +90,7 @@ const decodeOutput = <T extends Readonly<AbiFragmentNoErrConstructor>>(abi: T, o
 
 export class Method<AbiFrag extends Readonly<AbiFragmentNoErrConstructor>> {
     tronWeb: TronWeb;
-    contract: Contract;
+    contract: Contract<any>;
     abi: AbiFrag;
     name: string;
     inputs: AbiInputsType;
@@ -103,7 +103,7 @@ export class Method<AbiFrag extends Readonly<AbiFragmentNoErrConstructor>> {
         shouldPollResponse: boolean;
     };
 
-    constructor(contract: Contract, abi: AbiFrag) {
+    constructor(contract: Contract<any>, abi: AbiFrag) {
         this.tronWeb = contract.tronWeb;
         this.contract = contract;