Merge pull request #658 from multiversx/main

Merge main in feat next

Author: danielailie

cookbook/cookbook.md

@@ -2402,18 +2402,16 @@ After the `10-epoch unbonding period` is complete, we can proceed with withdrawi
 ```
 
 ### Relayed transactions
-We are currently on the `third iteration (V3)` of relayed transactions. V1 and V2 will soon be deactivated, so we will focus on V3.
+We are currently on the third iteration (V3) of relayed transactions. V1 and V2 will be deactivated soon, so we'll focus on V3.
 
-For V3, two new fields have been added to transactions:
-- relayer
-- relayerSignature
+For V3, two new fields have been added on transactions: `relayer` and `relayerSignature`.
 
-Signing Process:
-1. The relayer must be set before the sender signs the transaction.
-2. Once the sender has signed, the relayer can also sign the transaction and broadcast it.
+Note that:
+1. the sender and the relayer can sign the transaction in any order.
+2. before any of the sender or relayer can sign the transaction, the `relayer` field must be set.
+3. relayed transactions require an additional `50,000` of gas.
+4. the sender and the relayer must be in the same network shard.
 
-**Important Consideration**:
-Relayed V3 transactions require an additional `50,000` gas.
 Let’s see how to create a relayed transaction:
 
 ```js

cookbook/relayed.ts

@@ -3,18 +3,16 @@ import { Account, Address, DevnetEntrypoint, Transaction } from "../src"; // md-
 // md-start
 (async () => {
     // ### Relayed transactions
-    // We are currently on the `third iteration (V3)` of relayed transactions. V1 and V2 will soon be deactivated, so we will focus on V3.
-
-    // For V3, two new fields have been added to transactions:
-    // - relayer
-    // - relayerSignature
-
-    // Signing Process:
-    // 1. The relayer must be set before the sender signs the transaction.
-    // 2. Once the sender has signed, the relayer can also sign the transaction and broadcast it.
-
-    // **Important Consideration**:
-    // Relayed V3 transactions require an additional `50,000` gas.
+    // We are currently on the third iteration (V3) of relayed transactions. V1 and V2 will be deactivated soon, so we'll focus on V3.
+    //
+    // For V3, two new fields have been added on transactions: `relayer` and `relayerSignature`.
+    //
+    // Note that:
+    // 1. the sender and the relayer can sign the transaction in any order.
+    // 2. before any of the sender or relayer can sign the transaction, the `relayer` field must be set.
+    // 3. relayed transactions require an additional `50,000` of gas.
+    // 4. the sender and the relayer must be in the same network shard.
+    //
     // Let’s see how to create a relayed transaction:
 
     // ```js

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@multiversx/sdk-core",
-  "version": "15.0.0-beta.0",
+  "version": "15.1.1",
   "description": "MultiversX SDK for JavaScript and TypeScript",
   "author": "MultiversX",
   "homepage": "https://multiversx.com",

package.json

@@ -445,6 +445,12 @@ export class ExpectedAccountConditionNotReachedError extends Err {
  */
 export class ErrGasLimitCannotBeEstimated extends Err {
     public constructor(error: Error) {
-        super(`Failed to estimate gas limit: ${error}`, error);
+        super(`Failed to estimate gas limit: [${error}]`, error);
+    }
+}
+
+export class ErrEstimateTransactionCost extends Err {
+    public constructor(message: string) {
+        super(message);
     }
 }

src/core/errors.ts

@@ -12,6 +12,7 @@ export * from "./message";
 export * from "./networkParams";
 export * from "./smartContractQuery";
 export * from "./tokens";
+export * from "./tokenTransfersDataBuilder";
 export * from "./transaction";
 export * from "./transactionComputer";
 export * from "./transactionEvents";
@@ -20,4 +21,5 @@ export * from "./transactionOnNetwork";
 export * from "./transactionsFactoryConfig";
 export * from "./transactionStatus";
 export * from "./transactionWatcher";
+export * from "./utils.codec";
 export * from "./utils";

src/core/index.ts

@@ -16,7 +16,7 @@ import { GasLimitEstimator } from "../gasEstimator";
 import { GovernanceController, GovernanceTransactionsFactory } from "../governance";
 import { MultisigTransactionsFactory } from "../multisig";
 import { MultisigController } from "../multisig/multisigController";
-import { ApiNetworkProvider, ProxyNetworkProvider } from "../networkProviders";
+import { ApiNetworkProvider, NetworkProviderConfig, ProxyNetworkProvider } from "../networkProviders";
 import { INetworkProvider } from "../networkProviders/interface";
 import { SmartContractTransactionsFactory } from "../smartContracts";
 import { SmartContractController } from "../smartContracts/smartContractController";
@@ -34,19 +34,21 @@ export class NetworkEntrypoint {
     constructor(options: {
         networkProviderUrl: string;
         networkProviderKind: string;
+        networkProviderConfig?: NetworkProviderConfig;
         chainId: string;
         clientName?: string;
         withGasLimitEstimator?: boolean;
         gasLimitMultiplier?: number;
     }) {
+        const networkProviderConfig: NetworkProviderConfig = {
+            ...(options.networkProviderConfig ?? {}),
+            ...(options.clientName && { clientName: options.clientName }),
+        };
+
         if (options.networkProviderKind === "proxy") {
-            this.networkProvider = new ProxyNetworkProvider(options.networkProviderUrl, {
-                clientName: options.clientName,
-            });
+            this.networkProvider = new ProxyNetworkProvider(options.networkProviderUrl, networkProviderConfig);
         } else if (options.networkProviderKind === "api") {
-            this.networkProvider = new ApiNetworkProvider(options.networkProviderUrl, {
-                clientName: options.clientName,
-            });
+            this.networkProvider = new ApiNetworkProvider(options.networkProviderUrl, networkProviderConfig);
         } else {
             throw new ErrInvalidNetworkProviderKind();
         }
@@ -267,12 +269,14 @@ export class TestnetEntrypoint extends NetworkEntrypoint {
         clientName?: string;
         withGasLimitEstimator?: boolean;
         gasLimitMultiplier?: number;
+        networkProviderConfig?: NetworkProviderConfig;
     }) {
         const entrypointConfig = new TestnetEntrypointConfig();
         options = options || {};
         super({
             networkProviderUrl: options.url || entrypointConfig.networkProviderUrl,
             networkProviderKind: options.kind || entrypointConfig.networkProviderKind,
+            networkProviderConfig: options.networkProviderConfig,
             chainId: entrypointConfig.chainId,
             clientName: options.clientName,
             withGasLimitEstimator: options.withGasLimitEstimator,
@@ -288,12 +292,14 @@ export class DevnetEntrypoint extends NetworkEntrypoint {
         clientName?: string;
         withGasLimitEstimator?: boolean;
         gasLimitMultiplier?: number;
+        networkProviderConfig?: NetworkProviderConfig;
     }) {
         const entrypointConfig = new DevnetEntrypointConfig();
         options = options || {};
         super({
             networkProviderUrl: options.url || entrypointConfig.networkProviderUrl,
             networkProviderKind: options.kind || entrypointConfig.networkProviderKind,
+            networkProviderConfig: options.networkProviderConfig,
             chainId: entrypointConfig.chainId,
             clientName: options.clientName,
             withGasLimitEstimator: options.withGasLimitEstimator,
@@ -309,12 +315,14 @@ export class MainnetEntrypoint extends NetworkEntrypoint {
         clientName?: string;
         withGasLimitEstimator?: boolean;
         gasLimitMultiplier?: number;
+        networkProviderConfig?: NetworkProviderConfig;
     }) {
         const entrypointConfig = new MainnetEntrypointConfig();
         options = options || {};
         super({
             networkProviderUrl: options.url || entrypointConfig.networkProviderUrl,
             networkProviderKind: options.kind || entrypointConfig.networkProviderKind,
+            networkProviderConfig: options.networkProviderConfig,
             chainId: entrypointConfig.chainId,
             clientName: options.clientName,
             withGasLimitEstimator: options.withGasLimitEstimator,

src/entrypoints/entrypoints.ts

@@ -1,6 +1,7 @@
 import {
     Address,
     ErrContractQuery,
+    ErrEstimateTransactionCost,
     ErrNetworkProvider,
     getAxios,
     prepareTransactionForBroadcasting,
@@ -148,6 +149,10 @@ export class ProxyNetworkProvider implements INetworkProvider {
 
         const transaction = prepareTransactionForBroadcasting(copiedTx);
         const response = await this.doPostGeneric("transaction/cost", transaction);
+        const returnMessage: string = response.returnMessage;
+        if (returnMessage) {
+            throw new ErrEstimateTransactionCost(returnMessage);
+        }
         return TransactionCostResponse.fromHttpResponse(response);
     }