Update Relayer not to be optional

multiversx · Dec 12, 2024 · b810a2a · b810a2a
1 parent 642b00a
commit b810a2a
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 21 deletions.
diff --git a/src/converters/transactionsConverter.ts b/src/converters/transactionsConverter.ts
@@ -26,7 +26,7 @@ export class TransactionsConverter {
             chainID: transaction.chainID.valueOf(),
             version: transaction.version,
             options: transaction.options == 0 ? undefined : transaction.options,
-            relayer: !transaction.relayer || transaction.relayer.isEmpty() ? undefined : transaction.relayer.toBech32(),
+            relayer: transaction.relayer.isEmpty() ? undefined : transaction.relayer.toBech32(),
             guardian: transaction.guardian ? transaction.guardian : undefined,
             signature: this.toHexOrUndefined(transaction.signature),
             guardianSignature: this.toHexOrUndefined(transaction.guardianSignature),

diff --git a/src/interface.ts b/src/interface.ts
@@ -105,8 +105,8 @@ export interface ITransaction {
     version: number;
     options: number;
     guardian: string;
-    relayer?: Address;
+    relayer: Address;
     signature: Uint8Array;
     guardianSignature: Uint8Array;
-    relayerSignature?: Uint8Array;
+    relayerSignature: Uint8Array;
 }
diff --git a/src/proto/serializer.ts b/src/proto/serializer.ts
@@ -60,14 +60,18 @@ export class ProtoSerializer {
             protoTransaction.GuardianSignature = transaction.guardianSignature;
         }
 
-        if (transaction.relayer && !transaction.relayer.isEmpty()) {
-            protoTransaction.Relayer = transaction.relayer.getPublicKey();
+        if (this.isRelayedTransaction(transaction)) {
+            protoTransaction.Relayer = transaction.relayer?.getPublicKey();
             protoTransaction.RelayerSignature = transaction.relayerSignature;
         }
 
         return protoTransaction;
     }
 
+    private isRelayedTransaction(transaction: ITransaction) {
+        return !transaction.relayer.isEmpty();
+    }
+
     /**
      * Custom serialization, compatible with mx-chain-go.
      */

diff --git a/src/transaction.spec.ts b/src/transaction.spec.ts
@@ -755,8 +755,8 @@ describe("test transaction", async () => {
     it("should serialize transaction with relayer", async () => {
         const transaction = new Transaction({
             chainID: networkConfig.ChainID,
-            sender: wallets.alice.address.bech32(),
-            receiver: wallets.alice.address.bech32(),
+            sender: wallets.alice.address.toBech32(),
+            receiver: wallets.alice.address.toBech32(),
             relayer: wallets.bob.address,
             gasLimit: 50000n,
             value: 0n,
@@ -776,8 +776,8 @@ describe("test transaction", async () => {
     it("should test relayed v3", async () => {
         const transaction = new Transaction({
             chainID: networkConfig.ChainID,
-            sender: wallets.alice.address.bech32(),
-            receiver: wallets.alice.address.bech32(),
+            sender: wallets.alice.address.toBech32(),
+            receiver: wallets.alice.address.toBech32(),
             senderUsername: "alice",
             receiverUsername: "bob",
             gasLimit: 80000n,

diff --git a/src/transaction.ts b/src/transaction.ts
@@ -92,9 +92,10 @@ export class Transaction {
     public guardian: string;
 
     /**
-     * The relayer, in address format, next version all the other addresses will not be string anymore.
+     * The relayer address.
+     *  Note: in the next major version, `sender`, `receiver` and `guardian` will also have the type `Address`, instead of `string`.
      */
-    public relayer?: Address;
+    public relayer: Address;
 
     /**
      * The signature.
@@ -148,7 +149,7 @@ export class Transaction {
         this.version = Number(options.version?.valueOf() || TRANSACTION_VERSION_DEFAULT);
         this.options = Number(options.options?.valueOf() || TRANSACTION_OPTIONS_DEFAULT);
         this.guardian = options.guardian ? this.addressAsBech32(options.guardian) : "";
-        this.relayer = options.relayer?.isEmpty() ? undefined : options.relayer;
+        this.relayer = options.relayer ? options.relayer : Address.empty();
 
         this.signature = options.signature || Buffer.from([]);
         this.guardianSignature = options.guardianSignature || Buffer.from([]);

diff --git a/src/transactionComputer.ts b/src/transactionComputer.ts
@@ -1,5 +1,4 @@
 import BigNumber from "bignumber.js";
-import { Address } from "./address";
 import {
     MIN_TRANSACTION_VERSION_THAT_SUPPORTS_OPTIONS,
     TRANSACTION_OPTIONS_TX_GUARDED,
@@ -95,15 +94,8 @@ export class TransactionComputer {
         transaction.guardian = guardian;
     }
 
-    applyRelayer(transaction: ITransaction, relayer: Address) {
-        transaction.relayer = relayer;
-    }
-
     isRelayedV3Transaction(transaction: ITransaction) {
-        if (transaction.relayer && !transaction.relayer.isEmpty()) {
-            return true;
-        }
-        return false;
+        return !transaction.relayer.isEmpty();
     }
 
     applyOptionsForHashSigning(transaction: ITransaction) {