remove bytestring deps (#175)

* remove bytestring deps * generate new package set * address package set by hash * pin eth-core version
f-o-a-m · Apr 21, 2024 · 2dd330d · 2dd330d
1 parent 257e2e5
commit 2dd330d
Show file tree

Hide file tree

Showing 9 changed files with 74 additions and 77 deletions.
diff --git a/packages.dhall b/packages.dhall
@@ -3,38 +3,36 @@ let upstream =
         sha256:ca727657c01cc31d0e79c2113b59126b9826f4b56d20a8193be3c725599fb754
 
 let eth-core-deps =
-      https://raw.githubusercontent.com/f-o-a-m/purescript-eth-core/master/packages.dhall
-        sha256:af2751772a729d58edf7056805007934e3687b3079f8a02ac514e705aeab8c42
+      https://raw.githubusercontent.com/f-o-a-m/purescript-eth-core/aaa64b175717247f0ea6fe3c35780dea02ac8e3a/packages.dhall
+        sha256:ca727657c01cc31d0e79c2113b59126b9826f4b56d20a8193be3c725599fb754
 
 let additions =
-      { bytestrings = eth-core-deps.bytestrings
-      , coroutine-transducers = 
-        { dependencies = [
-            "console",
-            "either",
-            "foldable-traversable",
-            "freet",
-            "functors",
-            "newtype",
-            "parallel",
-            "prelude",
-            "tailrec",
-            "transformers",
-            "tuples",
-            "aff",
-            "coroutines",
-            "effect",
-            "maybe",
-            "psci-support"
-            ]
+      { coroutine-transducers =
+        { dependencies =
+          [ "console"
+          , "either"
+          , "foldable-traversable"
+          , "freet"
+          , "functors"
+          , "newtype"
+          , "parallel"
+          , "prelude"
+          , "tailrec"
+          , "transformers"
+          , "tuples"
+          , "aff"
+          , "coroutines"
+          , "effect"
+          , "maybe"
+          , "psci-support"
+          ]
         , repo = "https://github.com/martyall/purescript-coroutine-transducers"
         , version = "v1.0.0"
         }
       , eth-core =
         { dependencies =
           [ "argonaut"
           , "arrays"
-          , "bytestrings"
           , "effect"
           , "either"
           , "foldable-traversable"
@@ -51,7 +49,6 @@ let additions =
           , "ordered-collections"
           , "partial"
           , "prelude"
-          , "quotient"
           , "simple-json"
           , "strings"
           , "unfoldable"
@@ -60,7 +57,6 @@ let additions =
         , repo = "https://github.com/f-o-a-m/purescript-eth-core"
         , version = "v10.1.0"
         }
-      , quotient = eth-core-deps.quotient
       }
 
 in  upstream // additions
diff --git a/spago.dhall b/spago.dhall
@@ -4,7 +4,6 @@
   , "argonaut"
   , "arrays"
   , "bifunctors"
-  , "bytestrings"
   , "control"
   , "coroutine-transducers"
   , "coroutines"
@@ -18,8 +17,10 @@
   , "fork"
   , "gen"
   , "heterogeneous"
+  , "identity"
   , "maybe"
   , "newtype"
+  , "node-buffer"
   , "parallel"
   , "parsing"
   , "partial"
@@ -37,7 +38,6 @@
   , "unfoldable"
   , "unsafe-coerce"
   , "variant"
-  , "identity"
   ]
 , packages = ./packages.dhall
 , sources = [ "src/**/*.purs" ]

diff --git a/src/Network/Ethereum/Web3.purs b/src/Network/Ethereum/Web3.purs
@@ -11,11 +11,11 @@ import Network.Ethereum.Web3.Contract.Events (event', EventHandler, MultiFilterS
 import Network.Ethereum.Web3.Solidity
   ( Address
   , BigNumber
-  , ByteString
+  , ImmutableBuffer
   , BytesN
   , UIntN
   , Vector
-  , fromByteString
+  , fromBuffer
   , abiDecode
   , intNFromBigNumber
   , nilVector

diff --git a/src/Network/Ethereum/Web3/Solidity.purs b/src/Network/Ethereum/Web3/Solidity.purs
@@ -8,13 +8,13 @@ module Network.Ethereum.Web3.Solidity
   , module Network.Ethereum.Web3.Solidity.AbiEncoding
   , module Network.Ethereum.Web3.Solidity.Event
   , module Network.Ethereum.Types
-  , module Data.ByteString
+  , module Node.Buffer.Immutable
   ) where
 
-import Data.ByteString (ByteString)
+import Node.Buffer.Immutable (ImmutableBuffer)
 import Network.Ethereum.Types (BigNumber, Address)
 import Network.Ethereum.Web3.Solidity.AbiEncoding (class ABIDecode, class ABIEncode, class EncodingType, abiDecode, isDynamic, abiEncode)
-import Network.Ethereum.Web3.Solidity.Bytes (BytesN, unBytesN, proxyBytesN, update, fromByteString)
+import Network.Ethereum.Web3.Solidity.Bytes (BytesN, unBytesN, proxyBytesN, update, fromBuffer)
 import Network.Ethereum.Web3.Solidity.Event (class DecodeEvent, decodeEvent, class IndexedEvent, isAnonymous)
 import Network.Ethereum.Web3.Solidity.Int (IntN, unIntN, intNFromBigNumber)
 import Network.Ethereum.Web3.Solidity.Internal (class RecordFieldsIso, fromRecord, toRecord)

diff --git a/src/Network/Ethereum/Web3/Solidity/AbiEncoding.purs b/src/Network/Ethereum/Web3/Solidity/AbiEncoding.purs
@@ -16,9 +16,10 @@ module Network.Ethereum.Web3.Solidity.AbiEncoding
 
 import Prelude
 
+import Node.Encoding (Encoding(UTF8))
 import Data.Array (foldMap, foldl, length, sortBy, (:))
-import Data.ByteString (ByteString)
-import Data.ByteString (toUTF8, fromUTF8, length) as BS
+import Node.Buffer.Immutable (ImmutableBuffer)
+import Node.Buffer.Immutable as B
 import Data.Either (Either)
 import Data.Functor.Tagged (Tagged, tagged, untagged)
 import Data.Generic.Rep (class Generic, Argument(..), Constructor(..), NoArguments(..), Product(..), from, repOf, to)
@@ -32,7 +33,7 @@ import Data.Traversable (foldMapDefaultR)
 import Data.Tuple (Tuple(..))
 import Data.Unfoldable (replicateA)
 import Network.Ethereum.Core.BigNumber (fromString, fromTwosComplement, toString, toTwosComplement, unsafeToInt)
-import Network.Ethereum.Core.HexString (HexString, PadByte(..), fromByteString, mkHexString, numberOfBytes, padLeft, padRight, splitAtByteOffset, toByteString, unHex)
+import Network.Ethereum.Core.HexString (HexString, PadByte(..), fromBuffer, mkHexString, numberOfBytes, padLeft, padRight, splitAtByteOffset, toBuffer, unHex)
 import Network.Ethereum.Types (Address, BigNumber, fromInt, mkAddress, unAddress)
 import Network.Ethereum.Web3.Solidity.Bytes (BytesN, unBytesN, update, proxyBytesN)
 import Network.Ethereum.Web3.Solidity.Int (IntN, unIntN, intNFromBigNumber)
@@ -67,7 +68,7 @@ else instance EncodingType (BytesN n) where
   isDynamic = const false
 else instance EncodingType a => EncodingType (Vector n a) where
   isDynamic _ = isDynamic (Proxy :: Proxy a)
-else instance EncodingType ByteString where
+else instance EncodingType ImmutableBuffer where
   isDynamic = const true
 else instance EncodingType a => EncodingType (Tagged s a) where
   isDynamic _ = isDynamic (Proxy :: Proxy a)
@@ -114,11 +115,11 @@ else instance Reflectable n Int => ABIEncode (BytesN n) where
 else instance Reflectable n Int => ABIEncode (IntN n) where
   abiEncode a = int256HexBuilder <<< unIntN $ a
 
-else instance ABIEncode ByteString where
-  abiEncode bytes = uInt256HexBuilder (fromInt $ BS.length bytes) <> bytesBuilder bytes
+else instance ABIEncode ImmutableBuffer where
+  abiEncode bytes = uInt256HexBuilder (fromInt $ B.size bytes) <> bytesBuilder bytes
 
 else instance ABIEncode String where
-  abiEncode = abiEncode <<< BS.toUTF8
+  abiEncode = abiEncode <<< \a -> B.fromString a UTF8
 
 else instance ABIEncode a => ABIEncode (Array a) where
   abiEncode l =
@@ -221,8 +222,8 @@ factorBuilder a = Endo \encoded ->
     } : map (\x -> x { order = x.order + 1 }) encoded
 
 -- | base16 encode, then utf8 encode, then pad
-bytesBuilder :: ByteString -> HexString
-bytesBuilder = padRight Zero <<< fromByteString
+bytesBuilder :: ImmutableBuffer -> HexString
+bytesBuilder = padRight Zero <<< fromBuffer
 
 -- | Encode something that is essentaially a signed integer.
 int256HexBuilder :: BigNumber -> HexString
@@ -267,13 +268,13 @@ else instance ABIDecode Address where
     maddr <- mkAddress <$> parseBytes 20
     maybe (fail "Address is 20 bytes, receieved more") pure maddr
 
-else instance ABIDecode ByteString where
+else instance ABIDecode ImmutableBuffer where
   _abiDecode = do
     len <- _abiDecode
-    toByteString <$> parseBytes len
+    toBuffer <$> parseBytes len
 
 else instance ABIDecode String where
-  _abiDecode = BS.fromUTF8 <$> _abiDecode
+  _abiDecode = B.toString UTF8 <$> _abiDecode
 
 else instance Reflectable n Int => ABIDecode (BytesN n) where
   _abiDecode = do
@@ -282,7 +283,7 @@ else instance Reflectable n Int => ABIDecode (BytesN n) where
       zeroBytes = 32 - len
     raw <- parseBytes len
     _ <- parseBytes zeroBytes
-    pure <<< update proxyBytesN <<< toByteString $ raw
+    pure <<< update proxyBytesN <<< toBuffer $ raw
 
 else instance (Reflectable n Int, ABIDecode a) => ABIDecode (Vector n a) where
   _abiDecode =

diff --git a/src/Network/Ethereum/Web3/Solidity/Bytes.purs b/src/Network/Ethereum/Web3/Solidity/Bytes.purs
@@ -3,15 +3,16 @@ module Network.Ethereum.Web3.Solidity.Bytes
   , unBytesN
   , proxyBytesN
   , update
-  , fromByteString
+  , fromBuffer
   , generator
   ) where
 
 import Prelude
 
 import Control.Monad.Gen (class MonadGen)
-import Data.ByteString (empty, ByteString, Encoding(Hex))
-import Data.ByteString as BS
+import Node.Buffer.Immutable (ImmutableBuffer)
+import Node.Buffer.Immutable as B
+import Node.Encoding (Encoding(Hex))
 import Data.Maybe (Maybe(..), fromJust)
 import Data.Reflectable (class Reflectable, reflectType)
 import Network.Ethereum.Core.HexString as Hex
@@ -24,32 +25,32 @@ import Type.Proxy (Proxy(..))
 --------------------------------------------------------------------------------
 -- Represents a statically sized bytestring of size `n` bytes.
 -- | See module [Network.Ethereum.Web3.Solidity.Sizes](/Network.Ethereum.Web3.Solidity.Sizes) for some predefined sizes.
-newtype BytesN (n :: Int) = BytesN ByteString
+newtype BytesN (n :: Int) = BytesN ImmutableBuffer
 
 derive newtype instance eqBytesN :: Eq (BytesN n)
 instance showBytesN :: Show (BytesN n) where
-  show (BytesN bs) = show <<< unsafePartial fromJust <<< mkHexString $ BS.toString bs Hex
+  show (BytesN bs) = show <<< unsafePartial fromJust <<< mkHexString $ B.toString Hex bs
 
 generator :: forall n m. Reflectable n Int => MonadGen m => Proxy n -> m (BytesN n)
 generator p = do
   bs <- Hex.generator (reflectType p)
-  pure $ BytesN $ Hex.toByteString bs
+  pure $ BytesN $ Hex.toBuffer bs
 
 -- | Access the underlying raw bytestring
-unBytesN :: forall n. BytesN n -> ByteString
+unBytesN :: forall n. BytesN n -> ImmutableBuffer
 unBytesN (BytesN bs) = bs
 
 proxyBytesN :: forall n. BytesN n
-proxyBytesN = BytesN empty
+proxyBytesN = BytesN $ B.fromArray []
 
-update :: forall n. BytesN n -> ByteString -> BytesN n
+update :: forall n. BytesN n -> ImmutableBuffer -> BytesN n
 update _ = BytesN
 
 -- | Attempt to coerce a bytestring into one of the appropriate size.
 -- | See module [Network.Ethereum.Web3.Solidity.Sizes](/Network.Ethereum.Web3.Solidity.Sizes) for some predefined sizes.
-fromByteString :: forall proxy n. Reflectable n Int => proxy n -> ByteString -> Maybe (BytesN n)
-fromByteString _ bs =
-  if not $ BS.length bs <= reflectType (Proxy :: Proxy n) then
+fromBuffer :: forall proxy n. Reflectable n Int => proxy n -> ImmutableBuffer -> Maybe (BytesN n)
+fromBuffer _ bs =
+  if not $ B.size bs <= reflectType (Proxy :: Proxy n) then
     Nothing
   else
     Just $ BytesN bs
diff --git a/test.dhall b/test.dhall
@@ -13,7 +13,6 @@ in    conf
             , "nonempty"
             , "quickcheck"
             , "quickcheck-laws"
-            , "quotient"
             , "spec"
             , "unsafe-coerce"
             ]

diff --git a/test/web3/Web3Spec/Encoding/ContainersSpec.purs b/test/web3/Web3Spec/Encoding/ContainersSpec.purs
@@ -54,7 +54,7 @@ typePropertyTests =
     it "can encode/decode bytestring" $ liftEffect $ do
       quickCheckGen $ do
         n <- chooseInt 1 100
-        x <- Hex.toByteString <$> Hex.generator n
+        x <- Hex.toBuffer <$> Hex.generator n
         pure $ encodeDecode x === Right x
 
     it "can encode/decode bool" $ liftEffect $ do
@@ -300,7 +300,7 @@ tupleTests = do
           reifyType m \pm ->
             reifyType k \pk -> do
               ints <- arrayOf (IntN.generator pn)
-              bytes <- Hex.toByteString <$> (chooseInt 1 100 >>= Hex.generator)
+              bytes <- Hex.toBuffer <$> (chooseInt 1 100 >>= Hex.generator)
               addrs <- Vector.generator pm (arrayOf Address.generator)
               strings <- arrayOf (Vector.generator pk (arbitrary @BMPString))
               bool <- arbitrary :: Gen Boolean
@@ -364,7 +364,7 @@ tupleTests = do
                       let
                         mkTuple5 = do
                           ints <- arrayOf (IntN.generator _pn)
-                          bytes <- Hex.toByteString <$> (chooseInt 1 100 >>= Hex.generator)
+                          bytes <- Hex.toBuffer <$> (chooseInt 1 100 >>= Hex.generator)
                           addrs <- Vector.generator _pm (arrayOf Address.generator)
                           strings <- map (map (un BMPString)) <$>
                             arrayOf (Vector.generator _pk (arbitrary @BMPString))

diff --git a/test/web3/Web3Spec/Live/RPCSpec.purs b/test/web3/Web3Spec/Live/RPCSpec.purs
@@ -1,8 +1,9 @@
 module Web3Spec.Live.RPCSpec (spec) where
 
 import Prelude
-import Data.Array ((!!))
-import Data.ByteString as BS
+import Data.Array ((!!), last)
+import Node.Buffer.Immutable as B
+import Node.Encoding (Encoding(UTF8))
 import Data.Either (isRight)
 import Data.Lens ((?~), (%~))
 import Data.Maybe (Maybe(..), fromJust)
@@ -13,11 +14,9 @@ import Network.Ethereum.Core.Keccak256 (keccak256)
 import Network.Ethereum.Core.Signatures as Sig
 import Network.Ethereum.Web3 (Block(..), ChainCursor(..), Provider, TransactionReceipt(..), _from, _to, _value, convert, defaultTransactionOptions, fromMinorUnit, mkHexString, runWeb3)
 import Network.Ethereum.Web3.Api as Api
-import Node.Buffer.Class (slice)
 import Partial.Unsafe (unsafePartial)
 import Test.Spec (SpecT, describe, it)
 import Test.Spec.Assertions (shouldEqual, shouldSatisfy)
-import Type.Quotient (runQuotient)
 import Web3Spec.Live.Utils (assertWeb3, pollTransactionReceipt)
 
 spec :: Provider -> SpecT Aff Unit Aff Unit
@@ -111,7 +110,7 @@ spec provider =
       signer `shouldEqual` signer'
       -- make sure that we can recover the signature in purescript natively
       let
-        rsvSignature = case signatureFromByteString <<< Hex.toByteString $ signatureHex of
+        rsvSignature = case signatureFromByteString <<< Hex.toBuffer $ signatureHex of
           Sig.Signature sig -> Sig.Signature sig { v = sig.v - 27 }
       Sig.publicToAddress (Sig.recoverSender fullHashedMessageBS rsvSignature) `shouldEqual` signer
     it "Can call eth_estimateGas" do
@@ -141,28 +140,29 @@ spec provider =
           pure $ Tuple tx tx'
       tx `shouldEqual` tx'
 
-signatureFromByteString :: BS.ByteString -> Sig.Signature
-signatureFromByteString bs =
+signatureFromByteString :: B.ImmutableBuffer -> Sig.Signature
+signatureFromByteString bfr =
   let
-    bfr = BS.unsafeThaw bs
 
-    r = Hex.fromByteString $ BS.unsafeFreeze $ slice 0 32 bfr
+    r = Hex.fromBuffer $ B.slice 0 32 bfr
 
-    s = Hex.fromByteString $ BS.unsafeFreeze $ slice 32 64 bfr
+    s = Hex.fromBuffer $ B.slice 32 64 bfr
 
-    v = runQuotient $ unsafePartial fromJust $ BS.last bs
+    v = unsafePartial fromJust $ last $ B.toArray bfr
   in
     Sig.Signature { r, s, v }
 
 makeRidiculousEthereumMessage :: Hex.HexString -> Hex.HexString
 makeRidiculousEthereumMessage s =
   let
     prefix =
-      Hex.fromByteString
-        $ BS.toUTF8
-        $ "\x19" -- NOTE: 19 in hexadecimal is 25
+      Hex.fromBuffer
+        $ B.fromString
+            ( "\x19" -- NOTE: 19 in hexadecimal is 25
 
-            <> "Ethereum Signed Message:\n" -- NOTE: length of this string is 25
-            <> show (Hex.numberOfBytes s)
+                <> "Ethereum Signed Message:\n" -- NOTE: length of this string is 25
+                <> show (Hex.numberOfBytes s)
+            )
+            UTF8
   in
     prefix <> s