Transaction Improvements (Guardian, Relayer Support & more)

src/Http/Entities/Account.php

@@ -14,8 +14,8 @@ public function __construct(
         public Address $address,
         public int $nonce,
         public BigInteger $balance,
-        public int $txCount,
         public int $shard,
+        public ?int $txCount = null,
         public ?string $username = null,
         public ?string $rootHash = null,
     ) {

src/Transaction.php

@@ -12,6 +12,8 @@ class Transaction implements ISignable
     const OPTIONS_DEFAULT = 0;
 
     public ?Signature $signature = null;
+    public ?Signature $guardianSignature = null;
+    public ?Signature $relayerSignature = null;
 
     public function __construct(
         public int $nonce,
@@ -24,6 +26,10 @@ public function __construct(
         public string $chainID = '1',
         public int $version = self::VERSION_DEFAULT,
         public int $options = self::OPTIONS_DEFAULT,
+        public string $senderUsername = '',
+        public string $receiverUsername = '',
+        public ?Address $guardian = null,
+        public ?Address $relayer = null,
     ) {
     }
 
@@ -33,7 +39,7 @@ public function serializeForSigning(): string
             ->reject(fn ($field) => $field === null)
             ->toArray();
 
-        unset($plain['signature']);
+        unset($plain['signature'], $plain['guardianSignature'], $plain['relayerSignature']);
 
         return bin2hex(json_encode($plain));
     }
@@ -45,13 +51,19 @@ public function toArray(): array
             'value' => (string) $this->value,
             'receiver' => $this->receiver->bech32(),
             'sender' => $this->sender->bech32(),
+            'senderUsername' => $this->senderUsername ? base64_encode($this->senderUsername) : null,
+            'receiverUsername' => $this->receiverUsername ? base64_encode($this->receiverUsername) : null,
             'gasPrice' => $this->gasPrice,
             'gasLimit' => $this->gasLimit,
             'data' => $this->data?->toBase64(),
             'chainID' => $this->chainID,
             'version' => $this->version,
             'options' => $this->options === 0 ? null : $this->options,
+            'guardian' => $this->guardian?->bech32(),
+            'relayer' => $this->relayer?->bech32(),
             'signature' => $this->signature?->hex(),
+            'guardianSignature' => $this->guardianSignature?->hex(),
+            'relayerSignature' => $this->relayerSignature?->hex(),
         ];
     }
 
@@ -60,8 +72,90 @@ public function applySignature(Signature $signature): void
         $this->signature = $signature;
     }
 
+    public function applyGuardianSignature(Signature $signature): void
+    {
+        $this->guardianSignature = $signature;
+    }
+
+    public function applyRelayerSignature(Signature $signature): void
+    {
+        $this->relayerSignature = $signature;
+    }
+
     public function toSendable(): array
     {
         return $this->toArray();
     }
+
+    public function isGuardedTransaction(): bool
+    {
+        $hasGuardian = $this->guardian !== null && !$this->guardian->isZero();
+        $hasGuardianSignature = $this->guardianSignature !== null;
+
+        return $this->hasOptionsSetForGuardedTransaction() && $hasGuardian && $hasGuardianSignature;
+    }
+
+    private function hasOptionsSetForGuardedTransaction(): bool
+    {
+        return ($this->options & 0b0001) !== 0;
+    }
+
+    public static function fromArray(array $data): self
+    {
+        $senderUsername = '';
+        if (!empty($data['senderUsername'])) {
+            $senderUsername = base64_decode($data['senderUsername']);
+        }
+
+        $receiverUsername = '';
+        if (!empty($data['receiverUsername'])) {
+            $receiverUsername = base64_decode($data['receiverUsername']);
+        }
+
+        $guardian = null;
+        if (!empty($data['guardian'])) {
+            $guardian = Address::newFromBech32($data['guardian']);
+        }
+
+        $relayer = null;
+        if (!empty($data['relayer'])) {
+            $relayer = Address::newFromBech32($data['relayer']);
+        }
+
+        $dataPayload = null;
+        if (!empty($data['data'])) {
+            $dataPayload = new TransactionPayload(base64_decode($data['data']));
+        }
+
+        $transaction = new self(
+            nonce: $data['nonce'],
+            value: BigInteger::of($data['value'] ?? '0'),
+            sender: Address::newFromBech32($data['sender']),
+            receiver: Address::newFromBech32($data['receiver']),
+            gasPrice: $data['gasPrice'] ?? self::MIN_GAS_PRICE,
+            gasLimit: $data['gasLimit'],
+            data: $dataPayload,
+            chainID: $data['chainID'],
+            version: $data['version'] ?? self::VERSION_DEFAULT,
+            options: $data['options'] ?? self::OPTIONS_DEFAULT,
+            senderUsername: $senderUsername,
+            receiverUsername: $receiverUsername,
+            guardian: $guardian,
+            relayer: $relayer,
+        );
+
+        if (!empty($data['signature'])) {
+            $transaction->signature = new Signature($data['signature']);
+        }
+
+        if (!empty($data['guardianSignature'])) {
+            $transaction->guardianSignature = new Signature($data['guardianSignature']);
+        }
+
+        if (!empty($data['relayerSignature'])) {
+            $transaction->relayerSignature = new Signature($data['relayerSignature']);
+        }
+
+        return $transaction;
+    }
 }

tests/Http/Api/responses/accounts/account.json

@@ -1,9 +1,8 @@
 {
-    "address": "erd1qqqqqqqqqqqqqqqpqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqplllst77y4l",
-    "nonce": 404,
-    "balance": "46931489907311278839",
-    "rootHash": "lLXmK8ipiC9pEQaaaaaaaaaabbbbbbbbbbcccccccccc",
-    "txCount": 470,
-    "username": "aabbcc.elrond",
-    "shard": 1
+  "address": "erd1qqqqqqqqqqqqqqqpqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqplllst77y4l",
+  "nonce": 404,
+  "balance": "46931489907311278839",
+  "rootHash": "lLXmK8ipiC9pEQaaaaaaaaaabbbbbbbbbbcccccccccc",
+  "username": "aabbcc.elrond",
+  "shard": 1
 }

tests/Http/__snapshots__/AccountsTest____pest_evaluable_it_getByAddress___gets_an_account_by_address__1.json

@@ -4,16 +4,15 @@
     },
     "nonce": 404,
     "balance": "46931489907311278839",
-    "txCount": 470,
     "shard": 1,
+    "txCount": null,
     "username": "aabbcc.elrond",
     "rootHash": "lLXmK8ipiC9pEQaaaaaaaaaabbbbbbbbbbcccccccccc",
     "rawResponse": {
         "address": "erd1qqqqqqqqqqqqqqqpqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqplllst77y4l",
         "nonce": 404,
         "balance": "46931489907311278839",
         "rootHash": "lLXmK8ipiC9pEQaaaaaaaaaabbbbbbbbbbcccccccccc",
-        "txCount": 470,
         "username": "aabbcc.elrond",
         "shard": 1
     }

tests/Unit/TransactionTest.php

@@ -1,13 +1,15 @@
 <?php
 
-use Brick\Math\BigInteger;
 use MultiversX\Address;
+use MultiversX\Signature;
+use Brick\Math\BigInteger;
+use MultiversX\UserSigner;
 use MultiversX\Transaction;
 use MultiversX\TransactionPayload;
-use MultiversX\UserSigner;
 
 const ALICE_ADDRESS = 'erd1qyu5wthldzr8wx5c9ucg8kjagg0jfs53s8nr3zpz3hypefsdd8ssycr6th';
 const BOB_ADDRESS = 'erd1spyavw0956vq68xj8y4tenjpq2wd5a9p2c6j8gsz7ztyrnpxrruqzu66jx';
+const EVE_ADDRESS = 'erd1mmjkmtlz4cwl3svqtu4u9yfp3m8wqpqdykmterrleltpt4eaeyvsa68xa7';
 const MIN_GAS_LIMIT = 50_000;
 const MIN_GAS_PRICE = 1_000_000_000;
 
@@ -169,3 +171,52 @@
     expect($actual['options'])->toBeNull();
     expect($actual['signature'])->toBeNull();
 });
+
+it('should support guardian and relayer functionality', function () {
+    $guardian = Address::newFromBech32(EVE_ADDRESS);
+    $guardianSig = new Signature('guardian_sig');
+
+    $tx = new Transaction(
+        nonce: 90,
+        value: BigInteger::zero(),
+        sender: Address::newFromBech32(ALICE_ADDRESS),
+        receiver: Address::newFromBech32(BOB_ADDRESS),
+        gasPrice: MIN_GAS_PRICE,
+        gasLimit: MIN_GAS_LIMIT,
+        chainID: 'local-testnet',
+        options: 1,
+        guardian: $guardian
+    );
+
+    $tx->applyGuardianSignature($guardianSig);
+
+    expect($tx->isGuardedTransaction())->toBeTrue();
+    expect($tx->toArray()['guardian'])->toBe(EVE_ADDRESS);
+});
+
+it('should create transaction from array', function () {
+    $data = [
+        'nonce' => 90,
+        'value' => '123456789000000000000000000000',
+        'sender' => ALICE_ADDRESS,
+        'receiver' => BOB_ADDRESS,
+        'gasPrice' => MIN_GAS_PRICE,
+        'gasLimit' => 80000,
+        'data' => base64_encode('hello'),
+        'chainID' => 'local-testnet',
+        'senderUsername' => base64_encode('alice'),
+        'guardian' => 'erd1qqqqqqqqqqqqqqqpqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqplllst77y4l',
+        'signature' => 'test_signature'
+    ];
+
+    $tx = Transaction::fromArray($data);
+
+    expect($tx->nonce)->toBe(90);
+    expect((string) $tx->value)->toBe('123456789000000000000000000000');
+    expect($tx->sender->bech32())->toBe(ALICE_ADDRESS);
+    expect($tx->receiver->bech32())->toBe(BOB_ADDRESS);
+    expect($tx->data->data)->toBe('hello');
+    expect($tx->senderUsername)->toBe('alice');
+    expect($tx->guardian->bech32())->toBe('erd1qqqqqqqqqqqqqqqpqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqplllst77y4l');
+    expect($tx->signature->hex())->toBe('test_signature');
+});