[BFS-775] Remove blake2b hashing and refactor (#73)

Author: abdullahabro

docs/README.rfq.md

@@ -41,7 +41,7 @@ At the root of your working directory, create `rfq-contracts.json` and add the c
 
 ### Initializing the Client
 ```python
-# Seed phrase (mnemonic) of the wallet
+# Seed phrase (mnemonic) of the wallet (currently supports only ED25519)
 TEST_ACCT_PHRASE = "wallet seed phrase" 
 # RPC URL of the chain
 TEST_NETWORK = "https://fullnode.mainnet.sui.io:443"
@@ -60,7 +60,10 @@ rfq_client = RFQClient(wallet=wallet, url=TEST_NETWORK, rfq_contracts=rfq_contra
 
 ```
 
-### Creating and Signing a Quote
+### Creating and Signing a Quote 
+
+#### Supported wallets (No hashing required):
+- `ED25519`
 
 #### Parameters:
 - `vault` (str): On-chain vault object ID.
@@ -75,7 +78,7 @@ rfq_client = RFQClient(wallet=wallet, url=TEST_NETWORK, rfq_contracts=rfq_contra
 
 ```python
 
-# To only create the quote use
+# To only create the quote, use
 quote = rfq_client.create_quote(
     vault="0x67399451f127894ee0f9ff7182cbe914008a0197a97b54e86226d1c33635c368",
     quote_id="quote-123",
@@ -84,10 +87,13 @@ quote = rfq_client.create_quote(
     token_out_amount=200000000,
     token_in_type="0x2::sui::SUI",
     token_out_type="0x2::example::TOKEN",
-    created_at_utc_ms=1699765400,
+    expired_at_utc_ms=1699765400,
     created_at_utc_ms=1698765400,
 )
 
+# To sign the created quote , use
+quote.sign(rfq_client.wallet)
+
 #To create quote and sign it at the same time, use
 quote, signature = rfq_client.create_and_sign_quote(
     vault="0x67399451f127894ee0f9ff7182cbe914008a0197a97b54e86226d1c33635c368",
@@ -97,12 +103,16 @@ quote, signature = rfq_client.create_and_sign_quote(
     token_out_amount=200000000,
     token_in_type="0x2::sui::SUI",
     token_out_type="0x2::example::TOKEN",
-    created_at_utc_ms=1699765400,
+    expired_at_utc_ms=1699765400,
     created_at_utc_ms=1698765400,
 )
 ```
 
 ### Depositing Tokens into a Vault
+
+#### Supported wallets (blake2b hashing required, since its a sui transaction):
+- `ED25519`
+
 ```python
 rfq_client.deposit_in_vault(
     vault="0x40923d059eae6ccbbb91ac9442b80b9bec8262122a5756d96021e34cf33f0b1d",
@@ -112,6 +122,10 @@ rfq_client.deposit_in_vault(
 ```
 
 ### Withdrawing Tokens from a Vault
+
+#### Supported wallets (blake2b hashing required, since its a sui transaction):
+- `ED25519`
+
 ```python
 rfq_client.withdraw_from_vault(
     vault="0x40923d059eae6ccbbb91ac9442b80b9bec8262122a5756d96021e34cf33f0b1d",
@@ -121,6 +135,10 @@ rfq_client.withdraw_from_vault(
 ```
 
 ### Creating a new Vault
+
+#### Supported wallets (blake2b hashing required, since its a sui transaction):
+- `ED25519`
+
 ```python
 rfq_client.create_vault(
     manager="0x40923d059eae6ccbbb91ac9442b80b9bec8262122a5756d96021e34cf33f0b1d",
@@ -137,7 +155,7 @@ Initializes the RFQClient.
 - `url` (str): RPC URL of the chain node.
 - `rfq_contracts` (RFQContracts): Instance of RFQContracts.
 
-#### `create_quote(...) -> Quote`</br>`sign_quote(quote: Quote) -> str`</br> `create_and_sign_quote(...) -> Tuple[Quote, str]`
+#### `create_quote(...) -> Quote`</br> `create_and_sign_quote(...) -> Tuple[Quote, str]`
 
 
 Creates or/and signs a quote.

docs/openapi-client.yaml docs/openapi-rfq-client.ymldocs/openapi-client.yaml renamed to docs/openapi-rfq-client.yml

@@ -1,6 +1,6 @@
 [project]
 name = "bluefin_v2_client_sui"
-version = "1.1.5"
+version = "1.1.6"
 description = "Library to interact with Bluefin exchange protocol including its off-chain api-gateway and on-chain contracts"
 readme = "README.md"
 requires-python = ">=3.8"

pyproject.toml

@@ -1,5 +1,5 @@
 
-from sui_utils.bcs import BCSSerializer
+from sui_utils import *
 from typing import Self
 
 
@@ -43,9 +43,9 @@ def __init__(
         self.token_out_type = token_out_type
         self.expires_at = expires_at
         self.created_at = created_at
+        self.signer = Signer()
 
-    @staticmethod
-    def get_bcs_serialized_quote(quote: Self) -> bytes:
+    def get_bcs_serialized_quote(self) -> bytes:
         """
         Returns BCS serialized bytes of the quote.
 
@@ -57,15 +57,32 @@ def get_bcs_serialized_quote(quote: Self) -> bytes:
         serializer = BCSSerializer()
 
         # Apply BCS serialization to the Quote in correct order
-        serializer.serialize_address(quote.vault)  
-        serializer.serialize_str(quote.id) 
-        serializer.serialize_address(quote.taker)  
-        serializer.serialize_u64(quote.token_in_amount) 
-        serializer.serialize_u64(quote.token_out_amount)  
-        serializer.serialize_str(quote.token_in_type) 
-        serializer.serialize_str(quote.token_out_type)  
-        serializer.serialize_u64(quote.expires_at)  
-        serializer.serialize_u64(quote.created_at)  
+        serializer.serialize_address(self.vault)  
+        serializer.serialize_str(self.id) 
+        serializer.serialize_address(self.taker)  
+        serializer.serialize_u64(self.token_in_amount) 
+        serializer.serialize_u64(self.token_out_amount)  
+        serializer.serialize_str(self.token_in_type) 
+        serializer.serialize_str(self.token_out_type)  
+        serializer.serialize_u64(self.expires_at)  
+        serializer.serialize_u64(self.created_at)  
 
         return serializer.get_bytes()
+    
+    def sign(self, wallet: SuiWallet) -> bytes:
+        serializedBytes = self.get_bcs_serialized_quote()
+        signature = self.signer.sign_bytes(serializedBytes,wallet.privateKeyBytes)
+        scheme = wallet.getKeyScheme()
+
+        signatureBytes = bytearray()
+        if scheme == WALLET_SCHEME.ED25519:
+            signatureBytes.append(0)
+        else:
+            signatureBytes.append(1)
+        
+        signatureBytes.extend(signature)
+        signatureBytes.extend(wallet.publicKeyBytes)
+
+        return signatureBytes
+
 

src/bluefin_rfq_client/quote.py

@@ -77,22 +77,6 @@ def create_quote(
             expires_at=expires_at_utc_ms,
             created_at=created_at_utc_ms,
         )
-
-    def sign_quote(self, quote: Quote) -> str:
-        """
-        Signs the input Quote instance.
-
-        :param quote (Quote): instance of Quote class.
-
-        Returns:
-        Signature in hex format.
-        """
-        bcs_serialized_bytes = Quote.get_bcs_serialized_quote(quote)
-
-        # Sign bcs serialized quote bytes
-        signature = self.wallet.sign_personal_msg(bcs_serialized_bytes)
-    
-        return signature.hex()
 
     def create_and_sign_quote(
         self, 
@@ -141,10 +125,7 @@ def create_and_sign_quote(
             created_at=created_at_utc_ms,
         )
 
-        bcs_serialized_bytes = Quote.get_bcs_serialized_quote(quote)
-
-        # Sign bcs serialized quote bytes
-        signature = self.wallet.sign_personal_msg(bcs_serialized_bytes)
+        signature = quote.sign(self.wallet)
 
         return (quote, signature.hex())
 

src/bluefin_rfq_client/rfq.py

@@ -2,4 +2,5 @@
 from .utilities import *
 from .rpc import *
 from .signer import *
-from .bcs import *
+from .bcs import *
+from .enumerations import *

src/sui_utils/__init__.py

@@ -1,12 +1,11 @@
-import nacl
-import nacl.signing
+from .enumerations import WALLET_SCHEME
 from .utilities import *
 import base64
 from .bcs import *
 
 
 class SuiWallet:
-    def __init__(self, seed="", privateKey=""):
+    def __init__(self, seed="", privateKey="",scheme:WALLET_SCHEME = WALLET_SCHEME.ED25519):
         if seed == "" and privateKey == "":
             return "Error"
         if seed != "":
@@ -16,6 +15,7 @@ def __init__(self, seed="", privateKey=""):
             self.publicKeyBase64 = base64.b64encode(self.publicKey.ToBytes()[1:])
             self.privateKeyBase64 = base64.b64encode(self.privateKey.ToBytes()[1:])
             self.privateKeyBytes = self.privateKey.ToBytes()
+            self.scheme = scheme
 
         elif privateKey != "":
             self.privateKey = privateKey
@@ -24,12 +24,13 @@ def __init__(self, seed="", privateKey=""):
             self.publicKeyBase64 = base64.b64encode(self.publicKey.ToBytes()[1:])
             self.privateKeyBase64 = base64.b64encode(binascii.unhexlify(self.privateKey)[1:])
             self.privateKeyBytes = binascii.unhexlify(self.privateKey)
+            self.scheme = scheme
 
         else:
             return "error"
 
 
-        self.publicKeyBytes = self.publicKey.ToBytes()
+        self.publicKeyBytes = self.publicKey.ToBytes()[1:]
         self.address = getAddressFromPublicKey(self.publicKey)
 
     def getPublicKey(self):
@@ -48,29 +49,7 @@ def getPrivateKey(self):
     def getUserAddress(self):
         return self.address
 
-    def sign_personal_msg(self, serialized_bytes: bytearray):
-        serializer = BCSSerializer()
-        # this function adds len as an Unsigned Little Endian Base 128 similar to mysten SDK
-        serializer.serialize_uint8_array(list(serialized_bytes))
-        serialized_bytes = serializer.get_bytes()
-
-        # Add personal message intent bytes
-        intent = bytearray()
-        intent.extend([ 3, 0, 0]) # Intent scope for personal message
-
-        # Combine the intent and msg_bytes
-        intent = intent + serialized_bytes
-
-        # Combine blake2b hash
-        blake2bHash = hashlib.blake2b(intent, digest_size=32).digest()
-
-        # Sign the hash
-        signature = nacl.signing.SigningKey(self.privateKeyBytes).sign(blake2bHash)[:64]
-
-        
-        ED25519_SCHEME_FLAG = 0
-        serializer = BCSSerializer()
-        serializer.serialize_u8(ED25519_SCHEME_FLAG)
-        
-        # Construct Signature in accurate format (scheme + signature + publicKey)
-        return serializer.get_bytes()+ signature + self.publicKeyBytes[1:]
+    def getKeyScheme(self):
+        return self.scheme
+    
+    

src/sui_utils/account.py

@@ -1,4 +1,5 @@
 import struct
+from .utilities import *
 
 
 class BCSSerializer:
@@ -132,21 +133,3 @@ def hex_to_byte_array(hex_address: str) -> bytearray:
     except ValueError as e:
         raise ValueError(f"Invalid hex string: {e}")
 
-def decimal_to_bcs(num):
-        # Initialize an empty list to store the BCS bytes
-        bcs_bytes = []
-        while num > 0:
-            # Take the last 7 bits of the number
-            bcs_byte = num & 0x7F
-
-            # Set the most significant bit (MSB) to 1 if there are more bytes to follow
-            if num > 0x7F:
-                bcs_byte |= 0x80
-
-            # Append the BCS byte to the list
-            bcs_bytes.append(bcs_byte)
-
-            # Right-shift the number by 7 bits to process the next portion
-            num >>= 7
-
-        return bcs_bytes

src/sui_utils/bcs.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class WALLET_SCHEME(Enum):
+    ED25519 = "ED25519"
+    Secp256k1 = "Secp256k1" #not supportted currently