@tetherto/wdk-wallet-evm 1.0.0-beta.12 → 1.0.0-beta.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tetherto/wdk-wallet-evm",
-  "version": "1.0.0-beta.12",
+  "version": "1.0.0-beta.14",
   "description": "A simple package to manage BIP-32 wallets for evm blockchains.",
   "keywords": [
     "wdk",
@@ -31,8 +31,8 @@
     "@noble/hashes": "1.8.0",
     "@noble/secp256k1": "2.2.3",
     "@tetherto/wdk-failover-provider": "1.0.0-beta.2",
-    "@tetherto/wdk-wallet": "1.0.0-beta.8",
-    "bare-node-runtime": "^1.1.4",
+    "@tetherto/wdk-wallet": "1.0.0-beta.11",
+    "bare-node-runtime": "^1.5.0",
     "bip39": "3.1.0",
     "ethers": "6.14.4",
     "sodium-universal": "5.0.1"
@@ -46,13 +46,13 @@
     "typescript": "5.8.3"
   },
   "overrides": {
-    "brace-expansion": "1.1.13",
-    "cookie": "1.0.2",
+    "brace-expansion": "1.1.15",
+    "cookie": "1.1.1",
     "immutable": "4.3.8",
     "picomatch@2": "2.3.2",
     "serialize-javascript": ">=7.0.5",
-    "tmp": "0.2.5",
-    "undici": ">=7.24.0",
+    "tmp": "0.2.6",
+    "undici": "8.3.0",
     "uuid": "14.0.0"
   },
   "exports": {

package/src/wallet-account-evm.js

@@ -118,11 +118,15 @@ export default class WalletAccountEvm extends WalletAccountReadOnlyEvm {
   /**
    * The account's key pair.
    *
+   * The uint8 arrays are bound to the wallet account, so any external change will reflect to the internal representation. For this reason,
+   * it's strongly recommended to treat the key pair as a read-only view of the keys. While it's still technically possible to alter their
+   * content, client code should never do so.
+   *
    * @type {KeyPair}
    */
   get keyPair () {
     return {
-      privateKey: this._account.privateKeyBuffer,
+      privateKey: this._account.privateKeyBuffer ?? null,
       publicKey: this._account.publicKeyBuffer
     }
   }
@@ -150,10 +154,21 @@ export default class WalletAccountEvm extends WalletAccountReadOnlyEvm {
   /**
    * Signs a transaction.
    *
+   * If a provider is set, it also estimates the transaction's costs and checks them against the transaction max. fee option.
+   *
    * @param {EvmTransaction} tx - The transaction to sign.
    * @returns {Promise<string>} The signed transaction as a hex string.
+   * @throws {Error} If a provider is set, and the transaction's cost surpasses the transaction max. fee option.
    */
   async signTransaction (tx) {
+    if (this._account.provider && this._config.transactionMaxFee !== undefined) {
+      const { fee } = await this.quoteSendTransaction(tx)
+
+      if (fee > this._config.transactionMaxFee) {
+        throw new Error('Exceeded maximum fee cost for transaction operation.')
+      }
+    }
+
     return await this._account.signTransaction({
       from: await this.getAddress(),
       ...tx
@@ -165,6 +180,7 @@ export default class WalletAccountEvm extends WalletAccountReadOnlyEvm {
    *
    * @param {EvmTransaction} tx - The transaction.
    * @returns {Promise<TransactionResult>} The transaction's result.
+   * @throws {Error} If the transaction's cost exceeds the maximum transaction fee option.
    */
   async sendTransaction (tx) {
     if (!this._account.provider) {
@@ -173,6 +189,10 @@ export default class WalletAccountEvm extends WalletAccountReadOnlyEvm {
 
     const { fee } = await this.quoteSendTransaction(tx)
 
+    if (this._config.transactionMaxFee !== undefined && fee > this._config.transactionMaxFee) {
+      throw new Error('Exceeded maximum fee cost for transaction operation.')
+    }
+
     const { hash } = await this._account.sendTransaction({
       from: await this.getAddress(),
       ...tx
@@ -186,6 +206,7 @@ export default class WalletAccountEvm extends WalletAccountReadOnlyEvm {
    *
    * @param {EvmTransferOptions} options - The transfer's options.
    * @returns {Promise<TransferResult>} The transfer's result.
+   * @throws {Error} If the transfer's cost exceeds the maximum transfer fee option.
    */
   async transfer (options) {
     if (!this._account.provider) {
@@ -196,7 +217,7 @@ export default class WalletAccountEvm extends WalletAccountReadOnlyEvm {
 
     const { fee } = await this.quoteSendTransaction(tx)
 
-    if (this._config.transferMaxFee !== undefined && fee >= this._config.transferMaxFee) {
+    if (this._config.transferMaxFee !== undefined && fee > this._config.transferMaxFee) {
       throw new Error('Exceeded maximum fee cost for transfer operation.')
     }
 

package/src/wallet-account-read-only-evm.js

@@ -74,6 +74,7 @@ import FailoverProvider from '@tetherto/wdk-failover-provider'
  * @property {number} [retries] - If set and if 'provider' is a list of urls or EIP 1193 providers, the number of additional retry attempts after the initial call fails. Total attempts = `1 + retries`. For example, `retries: 3` with 4 providers will try each provider once before throwing. If `retries` exceeds the number of providers, the failover will loop back and retry already-failed providers in round-robin order. Default: 3.
  * @property {number} [chainId] - The chain ID of the network. When provided, skips automatic chain ID detection from the provider.
  * @property {number | bigint} [transferMaxFee] - The maximum fee amount for transfer operations.
+ * @property {number | bigint} [transactionMaxFee] - The maximum fee amount for sendTransaction and signTransaction operations.
  */
 
 const DELEGATION_DESIGNATOR_PREFIX = '0xef0100'
@@ -85,7 +86,7 @@ export default class WalletAccountReadOnlyEvm extends WalletAccountReadOnly {
    * Creates a new evm read-only wallet account.
    *
    * @param {string} address - The account's address.
-   * @param {Omit<EvmWalletConfig, 'transferMaxFee'>} [config] - The configuration object.
+   * @param {Omit<EvmWalletConfig, 'transferMaxFee' | 'transactionMaxFee'>} [config] - The configuration object.
    */
   constructor (address, config = { }) {
     super(address)
@@ -94,7 +95,7 @@ export default class WalletAccountReadOnlyEvm extends WalletAccountReadOnly {
      * The read-only wallet account configuration.
      *
      * @protected
-     * @type {Omit<EvmWalletConfig, 'transferMaxFee'>}
+     * @type {Omit<EvmWalletConfig, 'transferMaxFee' | 'transactionMaxFee'>}
      */
     this._config = config
 

package/types/src/wallet-account-evm.d.ts

@@ -37,6 +37,10 @@ export default class WalletAccountEvm extends WalletAccountReadOnlyEvm implement
     /**
      * The account's key pair.
      *
+     * The uint8 arrays are bound to the wallet account, so any external change will reflect to the internal representation. For this reason,
+     * it's strongly recommended to treat the key pair as a read-only view of the keys. While it's still technically possible to alter their
+     * content, client code should never do so.
+     *
      * @type {KeyPair}
      */
     get keyPair(): KeyPair;
@@ -57,8 +61,11 @@ export default class WalletAccountEvm extends WalletAccountReadOnlyEvm implement
     /**
      * Signs a transaction.
      *
+     * If a provider is set, it also estimates the transaction's costs and checks them against the transaction max. fee option.
+     *
      * @param {EvmTransaction} tx - The transaction to sign.
      * @returns {Promise<string>} The signed transaction as a hex string.
+     * @throws {Error} If a provider is set, and the transaction's cost surpasses the transaction max. fee option.
      */
     signTransaction(tx: EvmTransaction): Promise<string>;
     /**
@@ -66,6 +73,7 @@ export default class WalletAccountEvm extends WalletAccountReadOnlyEvm implement
      *
      * @param {EvmTransaction} tx - The transaction.
      * @returns {Promise<TransactionResult>} The transaction's result.
+     * @throws {Error} If the transaction's cost exceeds the maximum transaction fee option.
      */
     sendTransaction(tx: EvmTransaction): Promise<TransactionResult>;
     /**
@@ -73,6 +81,7 @@ export default class WalletAccountEvm extends WalletAccountReadOnlyEvm implement
      *
      * @param {EvmTransferOptions} options - The transfer's options.
      * @returns {Promise<TransferResult>} The transfer's result.
+     * @throws {Error} If the transfer's cost exceeds the maximum transfer fee option.
      */
     transfer(options: EvmTransferOptions): Promise<TransferResult>;
     /**

package/types/src/wallet-account-read-only-evm.d.ts

@@ -11,16 +11,16 @@ export default class WalletAccountReadOnlyEvm extends WalletAccountReadOnly {
      * Creates a new evm read-only wallet account.
      *
      * @param {string} address - The account's address.
-     * @param {Omit<EvmWalletConfig, 'transferMaxFee'>} [config] - The configuration object.
+     * @param {Omit<EvmWalletConfig, 'transferMaxFee' | 'transactionMaxFee'>} [config] - The configuration object.
      */
-    constructor(address: string, config?: Omit<EvmWalletConfig, "transferMaxFee">);
+    constructor(address: string, config?: Omit<EvmWalletConfig, "transferMaxFee" | "transactionMaxFee">);
     /**
      * The read-only wallet account configuration.
      *
      * @protected
-     * @type {Omit<EvmWalletConfig, 'transferMaxFee'>}
+     * @type {Omit<EvmWalletConfig, 'transferMaxFee' | 'transactionMaxFee'>}
      */
-    protected _config: Omit<EvmWalletConfig, "transferMaxFee">;
+    protected _config: Omit<EvmWalletConfig, "transferMaxFee" | "transactionMaxFee">;
     /**
      * An ethers provider to interact with a node of the blockchain.
      *
@@ -220,5 +220,9 @@ export type EvmWalletConfig = {
      * - The maximum fee amount for transfer operations.
      */
     transferMaxFee?: number | bigint;
+    /**
+     * - The maximum fee amount for sendTransaction and signTransaction operations.
+     */
+    transactionMaxFee?: number | bigint;
 };
 import { WalletAccountReadOnly } from '@tetherto/wdk-wallet';