Merge pull request #14 from zksync-sdk/develop

StanislavBreadless · web-flow · commit 4dc88f06d663 · 2021-08-25T16:14:18.000+03:00
Add toggle 2factor authentication request
diff --git a/src/main/java/io/zksync/domain/auth/Toggle2FA.java b/src/main/java/io/zksync/domain/auth/Toggle2FA.java
@@ -0,0 +1,18 @@
+package io.zksync.domain.auth;
+
+import io.zksync.signer.EthSignature;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+
+@Data
+@AllArgsConstructor
+public class Toggle2FA {
+
+    private boolean enable;
+
+    private Integer accountId;
+
+    private Long timestamp;
+
+    private EthSignature signature;
+}
diff --git a/src/main/java/io/zksync/provider/AsyncProvider.java b/src/main/java/io/zksync/provider/AsyncProvider.java
@@ -8,6 +8,7 @@
 import org.apache.commons.lang3.tuple.Pair;
 
 import io.zksync.domain.ChainId;
+import io.zksync.domain.auth.Toggle2FA;
 import io.zksync.domain.contract.ContractAddress;
 import io.zksync.domain.fee.TransactionFeeBatchRequest;
 import io.zksync.domain.fee.TransactionFeeDetails;
@@ -144,6 +145,14 @@ public interface AsyncProvider {
      */
     CompletableFuture<String> getEthTransactionForWithdrawal(String zkSyncWithdrawalHash);
 
+    /**
+     * Send signed toggle 2FA request to ZkSync network.
+     * 
+     * @param toggle2FA - Request object
+     * @return - true if successful, false otherwise
+     */
+    CompletableFuture<Boolean> toggle2FA(Toggle2FA toggle2FA);
+
     /**
      * Fetch and update local cache of token list
      * 
diff --git a/src/main/java/io/zksync/provider/DefaultAsyncProvider.java b/src/main/java/io/zksync/provider/DefaultAsyncProvider.java
@@ -2,6 +2,7 @@
 
 import org.apache.commons.lang3.tuple.Pair;
 
+import io.zksync.domain.auth.Toggle2FA;
 import io.zksync.domain.contract.ContractAddress;
 import io.zksync.domain.fee.TransactionFeeBatchRequest;
 import io.zksync.domain.fee.TransactionFeeDetails;
@@ -13,13 +14,15 @@
 import io.zksync.domain.transaction.TransactionDetails;
 import io.zksync.domain.transaction.ZkSyncTransaction;
 import io.zksync.signer.EthSignature;
+import io.zksync.transport.ZkSyncSuccess;
 import io.zksync.transport.ZkSyncTransport;
 import io.zksync.transport.response.ZksAccountState;
 import io.zksync.transport.response.ZksContractAddress;
 import io.zksync.transport.response.ZksEthOpInfo;
 import io.zksync.transport.response.ZksGetConfirmationsForEthOpAmount;
 import io.zksync.transport.response.ZksSentTransaction;
 import io.zksync.transport.response.ZksSentTransactionBatch;
+import io.zksync.transport.response.ZksToggle2FA;
 import io.zksync.transport.response.ZksTokenPrice;
 import io.zksync.transport.response.ZksTokens;
 import io.zksync.transport.response.ZksTransactionDetails;
@@ -163,6 +166,13 @@ public CompletableFuture<String> getEthTransactionForWithdrawal(String zkSyncWit
         return response;
     }
 
+    @Override
+    public CompletableFuture<Boolean> toggle2FA(Toggle2FA toggle2fa) {
+        final CompletableFuture<ZkSyncSuccess> result = transport.sendAsync("toggle_2fa", Collections.singletonList(toggle2fa), ZksToggle2FA.class);
+
+        return result.thenApply(ZkSyncSuccess::getSuccess);
+    }
+
     @Override
     public CompletableFuture<Tokens> updateTokenSet() {
         final CompletableFuture<Tokens> response = transport.sendAsync("tokens", Collections.emptyList(), ZksTokens.class);
diff --git a/src/main/java/io/zksync/provider/DefaultProvider.java b/src/main/java/io/zksync/provider/DefaultProvider.java
@@ -2,6 +2,7 @@
 
 import org.apache.commons.lang3.tuple.Pair;
 
+import io.zksync.domain.auth.Toggle2FA;
 import io.zksync.domain.contract.ContractAddress;
 import io.zksync.domain.fee.TransactionFeeBatchRequest;
 import io.zksync.domain.fee.TransactionFeeDetails;
@@ -13,13 +14,15 @@
 import io.zksync.domain.transaction.TransactionDetails;
 import io.zksync.domain.transaction.ZkSyncTransaction;
 import io.zksync.signer.EthSignature;
+import io.zksync.transport.ZkSyncSuccess;
 import io.zksync.transport.ZkSyncTransport;
 import io.zksync.transport.response.ZksAccountState;
 import io.zksync.transport.response.ZksContractAddress;
 import io.zksync.transport.response.ZksEthOpInfo;
 import io.zksync.transport.response.ZksGetConfirmationsForEthOpAmount;
 import io.zksync.transport.response.ZksSentTransaction;
 import io.zksync.transport.response.ZksSentTransactionBatch;
+import io.zksync.transport.response.ZksToggle2FA;
 import io.zksync.transport.response.ZksTokenPrice;
 import io.zksync.transport.response.ZksTokens;
 import io.zksync.transport.response.ZksTransactionDetails;
@@ -163,6 +166,13 @@ public String getEthTransactionForWithdrawal(String zkSyncWithdrawalHash) {
         return response;
     }
 
+    @Override
+    public boolean toggle2FA(Toggle2FA toggle2fa) {
+        final ZkSyncSuccess result = transport.send("toggle_2fa", Collections.singletonList(toggle2fa), ZksToggle2FA.class);
+
+        return result.getSuccess();
+    }
+
     public void updateTokenSet() {
         final Tokens response = transport.send("tokens", Collections.emptyList(), ZksTokens.class);
         this.tokens = response;
diff --git a/src/main/java/io/zksync/provider/Provider.java b/src/main/java/io/zksync/provider/Provider.java
@@ -7,6 +7,7 @@
 import org.apache.commons.lang3.tuple.Pair;
 
 import io.zksync.domain.ChainId;
+import io.zksync.domain.auth.Toggle2FA;
 import io.zksync.domain.contract.ContractAddress;
 import io.zksync.domain.fee.TransactionFeeBatchRequest;
 import io.zksync.domain.fee.TransactionFeeDetails;
@@ -144,6 +145,14 @@ public interface Provider {
      */
     String getEthTransactionForWithdrawal(String zkSyncWithdrawalHash);
 
+    /**
+     * Send signed toggle 2FA request to ZkSync network.
+     * 
+     * @param toggle2FA - Request object
+     * @return - true if successful, false otherwise
+     */
+    boolean toggle2FA(Toggle2FA toggle2FA);
+
     /**
      * Fetch and update local cache of token list
      * 
diff --git a/src/main/java/io/zksync/signer/Create2EthSigner.java b/src/main/java/io/zksync/signer/Create2EthSigner.java
@@ -77,6 +77,11 @@ public CompletableFuture<ChangePubKey<ChangePubKeyCREATE2>> signAuth(
         return CompletableFuture.completedFuture(changePubKey);
     }
 
+    @Override
+    public CompletableFuture<EthSignature> signToggle(boolean enable, Long timestamp) {
+        return CompletableFuture.completedFuture(null);
+    }
+
     @Override
     public <T extends ZkSyncTransaction> CompletableFuture<EthSignature> signTransaction(T transaction, Integer nonce,
             Token token, BigInteger fee) {
diff --git a/src/main/java/io/zksync/signer/DefaultEthSigner.java b/src/main/java/io/zksync/signer/DefaultEthSigner.java
@@ -114,6 +114,13 @@ public CompletableFuture<ChangePubKey<ChangePubKeyECDSA>> signAuth(ChangePubKey<
             });
     }
 
+    @Override
+    public CompletableFuture<EthSignature> signToggle(boolean enable, Long timestamp) {
+        final String message = SigningUtils.getToggle2FAMessage(enable, timestamp);
+
+        return signMessage(message.getBytes(), true);
+    }
+
     public <T extends ZkSyncTransaction> CompletableFuture<EthSignature> signTransaction(T tx, Integer nonce, Token token, BigInteger fee) {
         switch (tx.getType()) {
             case "ChangePubKey":
diff --git a/src/main/java/io/zksync/signer/EthSigner.java b/src/main/java/io/zksync/signer/EthSigner.java
@@ -37,6 +37,8 @@ public interface EthSigner<A extends ChangePubKeyVariant> {
 
     CompletableFuture<ChangePubKey<A>> signAuth(ChangePubKey<A> changePubKey);
 
+    CompletableFuture<EthSignature> signToggle(boolean enable, Long timestamp);
+
     /**
      * Sign `ZkSync` type operation message
      * 
diff --git a/src/main/java/io/zksync/signer/SigningUtils.java b/src/main/java/io/zksync/signer/SigningUtils.java
@@ -118,6 +118,28 @@ public static String getSwapMessagePart(Token token, BigInteger fee) {
         return result;
     }
 
+    public static String getToggle2FAMessage(boolean require2FA, Long timestamp) {
+        final String message;
+        if (require2FA) {
+            message = String.format(
+                "By signing this message, you are opting into Two-factor Authentication protection by the zkSync Server.\n" +
+                "Transactions now require signatures by both your L1 and L2 private key.\n" +
+                "Timestamp: %d",
+                timestamp
+            );
+        } else {
+            message = String.format(
+                "You are opting out of Two-factor Authentication protection by the zkSync Server.\n" +
+                "Transactions now only require signatures by your L2 private key.\n" +
+                "BY SIGNING THIS MESSAGE, YOU ARE TRUSTING YOUR WALLET CLIENT TO KEEP YOUR L2 PRIVATE KEY SAFE!\n" +
+                "Timestamp: %d",
+                timestamp
+            );
+        }
+
+        return message;
+    }
+
     public static String getNonceMessagePart(Integer nonce) {
         return String.format("Nonce: %s", nonce);
     }
diff --git a/src/main/java/io/zksync/transport/ZkSyncSuccess.java b/src/main/java/io/zksync/transport/ZkSyncSuccess.java
@@ -0,0 +1,10 @@
+package io.zksync.transport;
+
+import lombok.Data;
+
+@Data
+public class ZkSyncSuccess {
+
+    private Boolean success;
+    
+}
diff --git a/src/main/java/io/zksync/transport/response/ZksToggle2FA.java b/src/main/java/io/zksync/transport/response/ZksToggle2FA.java
@@ -0,0 +1,8 @@
+package io.zksync.transport.response;
+
+import io.zksync.transport.ZkSyncResponse;
+import io.zksync.transport.ZkSyncSuccess;
+
+public class ZksToggle2FA extends ZkSyncResponse<ZkSyncSuccess> {
+    
+}
diff --git a/src/main/java/io/zksync/wallet/DefaultZkASyncWallet.java b/src/main/java/io/zksync/wallet/DefaultZkASyncWallet.java
@@ -16,6 +16,7 @@
 import io.zksync.domain.TransactionBuildHelper;
 import io.zksync.domain.auth.ChangePubKeyOnchain;
 import io.zksync.domain.auth.ChangePubKeyVariant;
+import io.zksync.domain.auth.Toggle2FA;
 import io.zksync.domain.fee.TransactionFee;
 import io.zksync.domain.state.AccountState;
 import io.zksync.domain.swap.Order;
@@ -257,6 +258,40 @@ public EthereumProvider createEthereumProvider(Web3j web3j, ContractGasProvider
         return ethereum;
     }
 
+    @Override
+    public CompletableFuture<Boolean> enable2FA() {
+        final Long timestamp = System.currentTimeMillis();
+
+        return ethSigner.signToggle(true, timestamp)
+            .thenApply(ethSignature -> {
+                final Toggle2FA toggle2Fa = new Toggle2FA(
+                    true,
+                    this.getAccountId().join(),
+                    timestamp,
+                    ethSignature
+                );
+
+                return provider.toggle2FA(toggle2Fa).join();
+            });
+    }
+
+    @Override
+    public CompletableFuture<Boolean> disable2FA() {
+        final Long timestamp = System.currentTimeMillis();
+
+        return ethSigner.signToggle(false, timestamp)
+            .thenApply(ethSignature -> {
+                final Toggle2FA toggle2Fa = new Toggle2FA(
+                    false,
+                    this.getAccountId().join(),
+                    timestamp,
+                    ethSignature
+                );
+
+                return provider.toggle2FA(toggle2Fa).join();
+            });
+    }
+
     private CompletableFuture<String> submitSignedTransaction(ZkSyncTransaction signedTransaction,
                                          EthSignature ethereumSignature,
                                          boolean fastProcessing) {
diff --git a/src/main/java/io/zksync/wallet/DefaultZkSyncWallet.java b/src/main/java/io/zksync/wallet/DefaultZkSyncWallet.java
@@ -3,6 +3,7 @@
 import io.zksync.domain.TimeRange;
 import io.zksync.domain.auth.ChangePubKeyOnchain;
 import io.zksync.domain.auth.ChangePubKeyVariant;
+import io.zksync.domain.auth.Toggle2FA;
 import io.zksync.domain.fee.TransactionFee;
 import io.zksync.domain.state.AccountState;
 import io.zksync.domain.swap.Order;
@@ -258,6 +259,40 @@ public Tokens getTokens() {
         return this.provider.getTokens();
     }
 
+    @Override
+    public boolean enable2FA() {
+        final Long timestamp = System.currentTimeMillis();
+        final Integer accountId = this.getAccountId();
+
+        final EthSignature ethSignature = ethSigner.signToggle(true, timestamp).join();
+
+        final Toggle2FA toggle2Fa = new Toggle2FA(
+            true,
+            accountId,
+            timestamp,
+            ethSignature
+        );
+
+        return provider.toggle2FA(toggle2Fa);
+    }
+
+    @Override
+    public boolean disable2FA() {
+        final Long timestamp = System.currentTimeMillis();
+        final Integer accountId = this.getAccountId();
+
+        final EthSignature ethSignature = ethSigner.signToggle(false, timestamp).join();
+
+        final Toggle2FA toggle2Fa = new Toggle2FA(
+            false,
+            accountId,
+            timestamp,
+            ethSignature
+        );
+
+        return provider.toggle2FA(toggle2Fa);
+    }
+
     @SneakyThrows
     private SignedTransaction<ChangePubKey<A>> buildSignedChangePubKeyTx(TransactionFee fee, Integer nonce,
         TimeRange timeRange) {
diff --git a/src/main/java/io/zksync/wallet/ZkASyncWallet.java b/src/main/java/io/zksync/wallet/ZkASyncWallet.java
@@ -228,5 +228,19 @@ CompletableFuture<String> syncWithdraw(String ethAddress,
      */
     String getAddress();
 
+    /**
+     * Send request to enable 2-Factor authentication
+     * 
+     * @return true if successful, false otherwise
+     */
+    CompletableFuture<Boolean> enable2FA();
+
+    /**
+     * Send request to disable 2-Factor authentication
+     * 
+     * @return true if successful, false otherwise
+     */
+    CompletableFuture<Boolean> disable2FA();
+
     EthereumProvider createEthereumProvider(Web3j web3j, ContractGasProvider contractGasProvider);
 }
diff --git a/src/main/java/io/zksync/wallet/ZkSyncWallet.java b/src/main/java/io/zksync/wallet/ZkSyncWallet.java
@@ -222,6 +222,20 @@ String syncWithdraw(@NotNull String ethAddress,
      */
     Tokens getTokens();
 
+    /**
+     * Send request to enable 2-Factor authentication
+     * 
+     * @return true if successful, false otherwise
+     */
+    boolean enable2FA();
+
+    /**
+     * Send request to disable 2-Factor authentication
+     * 
+     * @return true if successful, false otherwise
+     */
+    boolean disable2FA();
+
     EthereumProvider createEthereumProvider(Web3j web3j, ContractGasProvider contractGasProvider);
 }
 
diff --git a/src/test/java/io/zksync/IntegrationTestFullFlow.java b/src/test/java/io/zksync/IntegrationTestFullFlow.java
@@ -352,5 +352,19 @@ public void getConfirmationsForEthOpAmount() {
 
         System.out.println(amount.toString());
     }
+
+    @Test
+    public void testEnable2FA() {
+        boolean success = wallet.enable2FA();
+
+        assertTrue(success);
+    }
+
+    @Test
+    public void testDisable2FA() {
+        boolean success = wallet.disable2FA();
+
+        assertTrue(success);
+    }
     
 }
diff --git a/src/test/java/io/zksync/IntegrationTestTransactionReceiptProcessor.java b/src/test/java/io/zksync/IntegrationTestTransactionReceiptProcessor.java

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,8 @@ public interface EthSigner<A extends ChangePubKeyVariant> {`
`37`	`37`
`38`	`38`	`CompletableFuture<ChangePubKey<A>> signAuth(ChangePubKey<A> changePubKey);`
`39`	`39`
	`40`	`+ CompletableFuture<EthSignature> signToggle(boolean enable, Long timestamp);`
	`41`	`+`
`40`	`42`	`/**`
`41`	`43`	* Sign `ZkSync` type operation message
`42`	`44`	`*`