refactor: add default contract addresses (#143)

ItsANameToo · web-flow · commit 20b4118194b0 · 2024-12-17T16:54:30.000+01:00
diff --git a/src/Enums/ContractAddresses.php b/src/Enums/ContractAddresses.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ArkEcosystem\Crypto\Enums;
+
+enum ContractAddresses: string
+{
+    case CONSENSUS    = '0x535B3D7A252fa034Ed71F0C53ec0C6F784cB64E1';
+    case MULTIPAYMENT = '0x83769BeEB7e5405ef0B7dc3C66C43E3a51A6d27f';
+    case USERNAMES    = '0x2c1DE3b4Dbb4aDebEbB5dcECAe825bE2a9fc6eb6';
+}
diff --git a/src/Identities/Address.php b/src/Identities/Address.php
@@ -4,7 +4,6 @@
 
 namespace ArkEcosystem\Crypto\Identities;
 
-use ArkEcosystem\Crypto\Networks\AbstractNetwork;
 use ArkEcosystem\Crypto\Utils\Address as AddressUtils;
 use BitWasp\Bitcoin\Crypto\EcAdapter\Impl\PhpEcc\Key\PrivateKey as EccPrivateKey;
 use Elliptic\EC;
@@ -91,7 +90,6 @@ public static function fromPrivateKey(EccPrivateKey $privateKey): string
      * Validate the given address.
      *
      * @param string $address
-     * @param AbstractNetwork|int|null $network
      *
      * @return bool
      */
diff --git a/src/Identities/PrivateKey.php b/src/Identities/PrivateKey.php
@@ -4,7 +4,6 @@
 
 namespace ArkEcosystem\Crypto\Identities;
 
-use ArkEcosystem\Crypto\Networks\AbstractNetwork;
 use BitWasp\Bitcoin\Bitcoin;
 use BitWasp\Bitcoin\Crypto\EcAdapter\EcAdapterFactory;
 use BitWasp\Bitcoin\Crypto\EcAdapter\Impl\PhpEcc\Key\PrivateKey as EcPrivateKey;
@@ -53,18 +52,17 @@ public static function fromHex($privateKey): EcPrivateKey
     /**
      * Derive the private key for the given WIF.
      *
-     * @param string                                             $wif
-     * @param AbstractNetwork|null $network
+     * @param string $wif
      *
      * @return EcPrivateKey
      */
-    public static function fromWif(string $wif, AbstractNetwork $network = null): EcPrivateKey
+    public static function fromWif(string $wif): EcPrivateKey
     {
         return (new PrivateKeyFactory(
             EcAdapterFactory::getPhpEcc(
                 Bitcoin::getMath(),
                 Bitcoin::getGenerator()
             )
-        ))->fromWif($wif, $network);
+        ))->fromWif($wif);
     }
 }
diff --git a/src/Identities/WIF.php b/src/Identities/WIF.php
@@ -4,20 +4,17 @@
 
 namespace ArkEcosystem\Crypto\Identities;
 
-use ArkEcosystem\Crypto\Networks\AbstractNetwork;
-
 class WIF
 {
     /**
      * Derive the WIF from the given passphrase.
      *
-     * @param string                                             $passphrase
-     * @param AbstractNetwork|null $network
+     * @param string $passphrase
      *
      * @return string
      */
-    public static function fromPassphrase(string $passphrase, AbstractNetwork $network = null): string
+    public static function fromPassphrase(string $passphrase): string
     {
-        return PrivateKey::fromPassphrase($passphrase)->toWif($network);
+        return PrivateKey::fromPassphrase($passphrase)->toWif();
     }
 }
diff --git a/src/Networks/Testnet.php b/src/Networks/Testnet.php
diff --git a/src/Transactions/Builder/UnvoteBuilder.php b/src/Transactions/Builder/UnvoteBuilder.php
@@ -4,11 +4,19 @@
 
 namespace ArkEcosystem\Crypto\Transactions\Builder;
 
+use ArkEcosystem\Crypto\Enums\ContractAddresses;
 use ArkEcosystem\Crypto\Transactions\Types\AbstractTransaction;
 use ArkEcosystem\Crypto\Transactions\Types\Unvote;
 
 class UnvoteBuilder extends AbstractTransactionBuilder
 {
+    public function __construct(?array $data = null)
+    {
+        parent::__construct($data);
+
+        $this->recipientAddress(ContractAddresses::CONSENSUS->value);
+    }
+
     protected function getTransactionInstance(?array $data = []): AbstractTransaction
     {
         return new Unvote($data);
diff --git a/src/Transactions/Builder/UsernameRegistrationBuilder.php b/src/Transactions/Builder/UsernameRegistrationBuilder.php
@@ -4,12 +4,20 @@
 
 namespace ArkEcosystem\Crypto\Transactions\Builder;
 
+use ArkEcosystem\Crypto\Enums\ContractAddresses;
 use ArkEcosystem\Crypto\Helpers;
 use ArkEcosystem\Crypto\Transactions\Types\AbstractTransaction;
 use ArkEcosystem\Crypto\Transactions\Types\UsernameRegistration;
 
 class UsernameRegistrationBuilder extends AbstractTransactionBuilder
 {
+    public function __construct(?array $data = null)
+    {
+        parent::__construct($data);
+
+        $this->recipientAddress(ContractAddresses::USERNAMES->value);
+    }
+
     public function username(string $username): self
     {
         Helpers::isValidUsername($username);
diff --git a/src/Transactions/Builder/UsernameResignationBuilder.php b/src/Transactions/Builder/UsernameResignationBuilder.php
@@ -4,11 +4,19 @@
 
 namespace ArkEcosystem\Crypto\Transactions\Builder;
 
+use ArkEcosystem\Crypto\Enums\ContractAddresses;
 use ArkEcosystem\Crypto\Transactions\Types\AbstractTransaction;
 use ArkEcosystem\Crypto\Transactions\Types\UsernameResignation;
 
 class UsernameResignationBuilder extends AbstractTransactionBuilder
 {
+    public function __construct(?array $data = null)
+    {
+        parent::__construct($data);
+
+        $this->recipientAddress(ContractAddresses::USERNAMES->value);
+    }
+
     protected function getTransactionInstance(?array $data = []): AbstractTransaction
     {
         return new UsernameResignation($data);
diff --git a/src/Transactions/Builder/ValidatorRegistrationBuilder.php b/src/Transactions/Builder/ValidatorRegistrationBuilder.php
@@ -4,11 +4,19 @@
 
 namespace ArkEcosystem\Crypto\Transactions\Builder;
 
+use ArkEcosystem\Crypto\Enums\ContractAddresses;
 use ArkEcosystem\Crypto\Transactions\Types\AbstractTransaction;
 use ArkEcosystem\Crypto\Transactions\Types\ValidatorRegistration;
 
 class ValidatorRegistrationBuilder extends AbstractTransactionBuilder
 {
+    public function __construct(?array $data = null)
+    {
+        parent::__construct($data);
+
+        $this->recipientAddress(ContractAddresses::CONSENSUS->value);
+    }
+
     public function validatorPublicKey(string $validatorPublicKey): self
     {
         $this->transaction->data['validatorPublicKey'] = $validatorPublicKey;
diff --git a/src/Transactions/Builder/ValidatorResignationBuilder.php b/src/Transactions/Builder/ValidatorResignationBuilder.php
@@ -4,11 +4,19 @@
 
 namespace ArkEcosystem\Crypto\Transactions\Builder;
 
+use ArkEcosystem\Crypto\Enums\ContractAddresses;
 use ArkEcosystem\Crypto\Transactions\Types\AbstractTransaction;
 use ArkEcosystem\Crypto\Transactions\Types\ValidatorResignation;
 
 class ValidatorResignationBuilder extends AbstractTransactionBuilder
 {
+    public function __construct(?array $data = null)
+    {
+        parent::__construct($data);
+
+        $this->recipientAddress(ContractAddresses::CONSENSUS->value);
+    }
+
     protected function getTransactionInstance(?array $data = []): AbstractTransaction
     {
         return new ValidatorResignation($data);
diff --git a/src/Transactions/Builder/VoteBuilder.php b/src/Transactions/Builder/VoteBuilder.php
@@ -4,11 +4,19 @@
 
 namespace ArkEcosystem\Crypto\Transactions\Builder;
 
+use ArkEcosystem\Crypto\Enums\ContractAddresses;
 use ArkEcosystem\Crypto\Transactions\Types\AbstractTransaction;
 use ArkEcosystem\Crypto\Transactions\Types\Vote;
 
 class VoteBuilder extends AbstractTransactionBuilder
 {
+    public function __construct(?array $data = null)
+    {
+        parent::__construct($data);
+
+        $this->recipientAddress(ContractAddresses::CONSENSUS->value);
+    }
+
     public function vote(string $vote): self
     {
         $this->transaction->data['vote'] = $vote;
diff --git a/src/Transactions/Deserializer.php b/src/Transactions/Deserializer.php
@@ -73,7 +73,7 @@ private function guessTransactionFromData(array $data): AbstractTransaction
         $payloadData = $this->decodePayload($data);
 
         if ($payloadData === null) {
-            return new EvmCall();
+            return new Transfer($data);
         }
 
         $functionName = $payloadData['functionName'];
diff --git a/src/Transactions/Types/AbstractTransaction.php b/src/Transactions/Types/AbstractTransaction.php
@@ -31,21 +31,6 @@ public function __construct(?array $data = null)
 
     abstract public function getPayload(): string;
 
-    public function decodePayload(array $data): ?array
-    {
-        if (! isset($data['data'])) {
-            return null;
-        }
-
-        $payload = $data['data'];
-
-        if ($payload === '') {
-            return null;
-        }
-
-        return (new AbiDecoder())->decodeFunctionData($payload);
-    }
-
     public function refreshPayloadData(): static
     {
         $this->data['data'] = ltrim($this->getPayload(), '0x');
@@ -185,6 +170,21 @@ public function hash(bool $skipSignature): BufferInterface
         return TransactionHasher::toHash($hashData, $skipSignature);
     }
 
+    protected function decodePayload(array $data): ?array
+    {
+        if (! isset($data['data'])) {
+            return null;
+        }
+
+        $payload = $data['data'];
+
+        if ($payload === '') {
+            return null;
+        }
+
+        return (new AbiDecoder())->decodeFunctionData($payload);
+    }
+
     private function getSignature(): CompactSignatureInterface
     {
         $ecAdapter = EcAdapterFactory::getPhpEcc(
diff --git a/src/Utils/Address.php b/src/Utils/Address.php
@@ -5,7 +5,6 @@
 namespace ArkEcosystem\Crypto\Utils;
 
 use ArkEcosystem\Crypto\ByteBuffer\ByteBuffer;
-use ArkEcosystem\Crypto\Networks\AbstractNetwork;
 use BitWasp\Buffertools\Buffer;
 use kornrunner\Keccak;
 
@@ -15,7 +14,6 @@ class Address
      * Validate the given address.
      *
      * @param string $address
-     * @param AbstractNetwork|int|null $network
      *
      * @return bool
      */
diff --git a/tests/Unit/Networks/TestnetTest.php b/tests/Unit/Networks/TestnetTest.php
diff --git a/tests/Unit/Transactions/Builder/UnvoteBuilderTest.php b/tests/Unit/Transactions/Builder/UnvoteBuilderTest.php
@@ -22,7 +22,6 @@ public function it_should_sign_it_with_a_passphrase()
           ->nonce($fixture['data']['nonce'])
           ->network($fixture['data']['network'])
           ->gasLimit($fixture['data']['gasLimit'])
-          ->recipientAddress($fixture['data']['recipientAddress'])
           ->sign($this->passphrase);
 
         $this->assertSame($fixture['serialized'], $builder->transaction->serialize()->getHex());
diff --git a/tests/Unit/Transactions/Builder/UsernameRegistrationBuilderTest.php b/tests/Unit/Transactions/Builder/UsernameRegistrationBuilderTest.php
@@ -23,7 +23,6 @@ public function it_should_sign_it_with_a_passphrase()
           ->nonce($fixture['data']['nonce'])
           ->network($fixture['data']['network'])
           ->gasLimit($fixture['data']['gasLimit'])
-          ->recipientAddress($fixture['data']['recipientAddress'])
           ->username('php')
           ->sign($this->passphrase);
 
@@ -47,7 +46,6 @@ public function it_should_throw_exception_for_invalid_username()
           ->nonce($fixture['data']['nonce'])
           ->network($fixture['data']['network'])
           ->gasLimit($fixture['data']['gasLimit'])
-          ->recipientAddress($fixture['data']['recipientAddress'])
           ->username('this_is_a_very_long_username_that_is_invalid')
           ->sign($this->passphrase);
     }
diff --git a/tests/Unit/Transactions/Builder/UsernameResignationBuilderTest.php b/tests/Unit/Transactions/Builder/UsernameResignationBuilderTest.php
@@ -22,7 +22,6 @@ public function it_should_sign_it_with_a_passphrase()
           ->nonce($fixture['data']['nonce'])
           ->network($fixture['data']['network'])
           ->gasLimit($fixture['data']['gasLimit'])
-          ->recipientAddress($fixture['data']['recipientAddress'])
           ->sign($this->passphrase);
 
         $this->assertSame($fixture['serialized'], $builder->transaction->serialize()->getHex());
diff --git a/tests/Unit/Transactions/Builder/ValidatorRegistrationBuilderTest.php b/tests/Unit/Transactions/Builder/ValidatorRegistrationBuilderTest.php
@@ -22,8 +22,7 @@ public function it_should_sign_it_with_a_passphrase()
           ->nonce($fixture['data']['nonce'])
           ->network($fixture['data']['network'])
           ->gasLimit($fixture['data']['gasLimit'])
-          ->validatorPublicKey('a08058db53e2665c84a40f5152e76dd2b652125a6079130d4c315e728bcf4dd1dfb44ac26e82302331d61977d3141118')
-          ->recipientAddress($fixture['data']['recipientAddress'])
+          ->validatorPublicKey('954f46d6097a1d314e900e66e11e0dad0a57cd03e04ec99f0dedd1c765dcb11e6d7fa02e22cf40f9ee23d9cc1c0624bd')
           ->sign($this->passphrase);
 
         $this->assertSame($fixture['serialized'], $builder->transaction->serialize()->getHex());
diff --git a/tests/Unit/Transactions/Builder/ValidatorResignationBuilderTest.php b/tests/Unit/Transactions/Builder/ValidatorResignationBuilderTest.php
@@ -22,7 +22,6 @@ public function it_should_sign_it_with_a_passphrase()
           ->nonce($fixture['data']['nonce'])
           ->network($fixture['data']['network'])
           ->gasLimit($fixture['data']['gasLimit'])
-          ->recipientAddress($fixture['data']['recipientAddress'])
           ->sign($this->passphrase);
 
         $this->assertSame($fixture['serialized'], $builder->transaction->serialize()->getHex());
diff --git a/tests/Unit/Transactions/Builder/VoteBuilderTest.php b/tests/Unit/Transactions/Builder/VoteBuilderTest.php
diff --git a/tests/Unit/Transactions/DeserializerTest.php b/tests/Unit/Transactions/DeserializerTest.php
diff --git a/tests/fixtures/transactions/evm_call/transfer-0.json b/tests/fixtures/transactions/evm_call/transfer-0.json
diff --git a/tests/fixtures/transactions/evm_call/unvote.json b/tests/fixtures/transactions/evm_call/unvote.json
diff --git a/tests/fixtures/transactions/evm_call/validator-registration.json b/tests/fixtures/transactions/evm_call/validator-registration.json
diff --git a/tests/fixtures/transactions/evm_call/validator-resignation.json b/tests/fixtures/transactions/evm_call/validator-resignation.json
diff --git a/tests/fixtures/transactions/evm_call/vote.json b/tests/fixtures/transactions/evm_call/vote.json

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@`
`4`	`4`
`5`	`5`	`namespace ArkEcosystem\Crypto\Identities;`
`6`	`6`
`7`		`-use ArkEcosystem\Crypto\Networks\AbstractNetwork;`
`8`	`7`	`use ArkEcosystem\Crypto\Utils\Address as AddressUtils;`
`9`	`8`	`use BitWasp\Bitcoin\Crypto\EcAdapter\Impl\PhpEcc\Key\PrivateKey as EccPrivateKey;`
`10`	`9`	`use Elliptic\EC;`
`@@ -91,7 +90,6 @@ public static function fromPrivateKey(EccPrivateKey $privateKey): string`
`91`	`90`	`* Validate the given address.`
`92`	`91`	`*`
`93`	`92`	`* @param string $address`
`94`		`- * @param AbstractNetwork\|int\|null $network`
`95`	`93`	`*`
`96`	`94`	`* @return bool`
`97`	`95`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -4,20 +4,17 @@`
`4`	`4`
`5`	`5`	`namespace ArkEcosystem\Crypto\Identities;`
`6`	`6`
`7`		`-use ArkEcosystem\Crypto\Networks\AbstractNetwork;`
`8`		`-`
`9`	`7`	`class WIF`
`10`	`8`	`{`
`11`	`9`	`/**`
`12`	`10`	`* Derive the WIF from the given passphrase.`
`13`	`11`	`*`
`14`		`- * @param string $passphrase`
`15`		`- * @param AbstractNetwork\|null $network`
	`12`	`+ * @param string $passphrase`
`16`	`13`	`*`
`17`	`14`	`* @return string`
`18`	`15`	`*/`
`19`		`- public static function fromPassphrase(string $passphrase, AbstractNetwork $network = null): string`
	`16`	`+ public static function fromPassphrase(string $passphrase): string`
`20`	`17`	`{`
`21`		`- return PrivateKey::fromPassphrase($passphrase)->toWif($network);`
	`18`	`+ return PrivateKey::fromPassphrase($passphrase)->toWif();`
`22`	`19`	`}`
`23`	`20`	`}`