[TransactionRequestInput] - add fields (#1562)

* fix: add coment and delegateUrl params

* fix: fix failing test

* fix: increase testing time

---------

Co-authored-by: Miguel Angel Rojo <freemanz1486@gmail.com>

packages/network/src/signer/signers/types.d.ts

@@ -159,6 +159,16 @@ interface TransactionRequestInput {
      */
     gasPayer?: string;
 
+    /**
+     * The delegation URL to use to sponsor the transaction.
+     */
+    delegationUrl?: string;
+
+    /**
+     * A comment describing the transaction request.
+     */
+    comment?: string;
+
     // START: NOT SUPPORTED FIELDS in VeChain BUT added to take compatibility with ethers
 
     /**

packages/network/src/signer/signers/vechain-private-key-signer/vechain-private-key-signer.ts

@@ -103,12 +103,21 @@ class VeChainPrivateKeySigner extends VeChainAbstractSigner {
             );
         }
 
+        let delegator = DelegationHandler(
+            await this.provider.wallet?.getDelegator()
+        ).delegatorOrNull();
+
+        // Override the delegator if the transaction has a delegation URL
+        if (transactionToSign.delegationUrl !== undefined) {
+            delegator = {
+                delegatorUrl: transactionToSign.delegationUrl
+            };
+        }
+
         // Sign the transaction
         return await this._signFlow(
             transactionToSign,
-            DelegationHandler(
-                await this.provider?.wallet?.getDelegator()
-            ).delegatorOrNull(),
+            delegator,
             this.provider.thorClient
         );
     }

packages/network/src/thor-client/contracts/types.d.ts

@@ -30,6 +30,16 @@ declare module 'viem/node_modules/abitype' {
 type ContractTransactionOptions = {
     value?: number;
     signTransactionOptions?: SignTransactionOptions;
+
+    /**
+     * The delegation URL to use to sponsor the transaction.
+     */
+    delegationUrl?: string;
+
+    /**
+     * A comment describing the transaction request.
+     */
+    comment?: string;
 } & TransactionBodyOptions &
     ClauseOptions;
 

packages/network/src/thor-client/transactions/transactions-module.ts

@@ -780,7 +780,9 @@ class TransactionsModule {
             dependsOn: options?.dependsOn,
             expiration: options?.expiration,
             chainTag: options?.chainTag,
-            blockRef: options?.blockRef
+            blockRef: options?.blockRef,
+            delegationUrl: options?.delegationUrl,
+            comment: options?.comment
         });
 
         return {
@@ -813,7 +815,9 @@ class TransactionsModule {
             dependsOn: options?.dependsOn,
             expiration: options?.expiration,
             chainTag: options?.chainTag,
-            blockRef: options?.blockRef
+            blockRef: options?.blockRef,
+            delegationUrl: options?.delegationUrl,
+            comment: options?.comment
         });
 
         return {

packages/network/tests/signer/signers/vechain-private-key-signer/vechain-private-key-signer.testnet.test.ts

@@ -102,6 +102,32 @@ describe('VeChain base signer tests - testnet', () => {
                 }
             }
         }, 8000);
+
+        /**
+         * Should be able to request delegation URLs per transaction
+         */
+        test('Should be able to request delegation URLs per transaction', async () => {
+            for (const fixture of signTransactionTestCases.testnet.correct) {
+                if (fixture.isDelegated) {
+                    const signer = new VeChainPrivateKeySigner(
+                        HexUInt.of(fixture.origin.privateKey).bytes,
+                        new VeChainProvider(
+                            thorClient,
+                            THOR_SOLO_ACCOUNTS_BASE_WALLET,
+                            false
+                        )
+                    );
+
+                    // Sign the transaction
+                    const signedTransaction = await signer.signTransaction({
+                        from: fixture.origin.address,
+                        delegationUrl: fixture.options.delegatorUrl
+                    });
+
+                    expect(signedTransaction).toBeDefined();
+                }
+            }
+        });
     });
 
     /**

packages/network/tests/thor-client/contracts/contract.erc20.testnet.test.ts

@@ -3,6 +3,7 @@ import {
     ProviderInternalBaseWallet,
     TESTNET_URL,
     ThorClient,
+    type TransactionReceipt,
     VeChainProvider,
     type VeChainSigner
 } from '../../../src';
@@ -11,7 +12,7 @@ import {
     ERC20_CONTRACT_ADDRESS_ON_TESTNET,
     TESTNET_DELEGATE_URL
 } from './fixture';
-import { ERC20_ABI, HexUInt } from '@vechain/sdk-core';
+import { ABIContract, ERC20_ABI, HexUInt } from '@vechain/sdk-core';
 
 /**
  * Tests for the ThorClient class, specifically focusing on ERC20 contract-related functionality.
@@ -75,4 +76,27 @@ describe('ThorClient - ERC20 Contracts on testnet', () => {
 
         expect(txResult?.reverted).toBe(false);
     }, 30000);
+
+    /**
+     * Test transaction with url delegation per transaction.
+     */
+    test('transaction with url delegation per transaction', async () => {
+        const txResult = await thorTestnetClient.contracts.executeTransaction(
+            (await providerWithDelegationEnabled.getSigner(
+                TEST_ACCOUNTS.TRANSACTION.TRANSACTION_SENDER.address
+            )) as VeChainSigner,
+            ERC20_CONTRACT_ADDRESS_ON_TESTNET,
+            ABIContract.ofAbi(ERC20_ABI).getFunction('transfer'),
+            [TEST_ACCOUNTS.TRANSACTION.DELEGATOR.address, 1000n],
+            {
+                comment: 'test comment',
+                delegationUrl: TESTNET_DELEGATE_URL
+            }
+        );
+
+        const result = (await txResult.wait()) as TransactionReceipt;
+
+        expect(result.reverted).toBeFalsy();
+        expect(result.gasPayer).not.toBe(result.meta.txOrigin);
+    }, 30000);
 });