Merge pull request #98 from aslesarenko/scala-js

Cross-compile to Scala.js

Author: kushti

.github/workflows/ci.yml

@@ -15,13 +15,13 @@ env:
 
 jobs:
   build:
-    name: Test and publish a snapshot
+    name: JVM - Test and publish a snapshot
     env:
       HAS_SECRETS: ${{ secrets.SONATYPE_PASSWORD != '' }}
     strategy:
       matrix:
         os: [ubuntu-latest]
-        scala: [2.12.10, 2.11.12, 2.13.1]
+        scala: [2.13.8, 2.12.15, 2.11.12]
         java: [adopt@1.8]
     runs-on: ${{ matrix.os }}
     steps:
@@ -48,11 +48,60 @@ jobs:
           key: ${{ runner.os }}-sbt-cache-v2-${{ hashFiles('**/*.sbt') }}-${{ hashFiles('project/build.properties') }}
 
       - name: Runs tests
-        run: sbt ++${{ matrix.scala }} test 
+        run: sbt ++${{ matrix.scala }} scryptoJVM/test
 
       - name: Publish a snapshot ${{ github.ref }}
         if: env.HAS_SECRETS == 'true'
-        run: sbt ++${{ matrix.scala }} publish
+        run: sbt ++${{ matrix.scala }} scryptoJVM/publish
+        env:
+          SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
+          SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
+
+  buildJs:
+    name: JS - Test and publish a snapshot
+    env:
+      HAS_SECRETS: ${{ secrets.SONATYPE_PASSWORD != '' }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        scala: [2.13.8, 2.12.15]
+        java: [adopt@1.8]
+        node-version: [16.x]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup NPM
+        uses: pnpm/action-setup@v2
+        with:
+          version: 7.21.0
+          node-version: ${{ matrix.node-version }}
+          cache: "pnpm"
+      - run: pnpm install
+
+      - name: Setup Java and Scala
+        uses: olafurpg/setup-scala@v10
+        with:
+          java-version: ${{ matrix.java }}
+
+      - name: Cache sbt
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.sbt
+            ~/.ivy2/cache
+            ~/.coursier/cache/v1
+            ~/.cache/coursier/v1
+            ~/AppData/Local/Coursier/Cache/v1
+            ~/Library/Caches/Coursier/v1
+          key: ${{ runner.os }}-sbt-cache-v2-${{ hashFiles('**/*.sbt') }}-${{ hashFiles('project/build.properties') }}
+
+      - name: Runs tests
+        run: sbt ++${{ matrix.scala }} scryptoJS/test
+
+      - name: Publish a snapshot ${{ github.ref }}
+        if: env.HAS_SECRETS == 'true'
+        run: sbt ++${{ matrix.scala }} scryptoJS/publish
         env:
           SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
           SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}

README.md

@@ -95,7 +95,7 @@ Here are code examples for generating proofs and checking them. In this example
 * First, we create a prover and get an initial digest from it (in a real application, this value is a public constant because anyone, including verifiers, can compute it by using the same two lines of code)
 
 ```scala
-  import com.google.common.primitives.Longs
+  import scorex.utils.Longs
   import scorex.crypto.authds.{ADKey, ADValue}
   import scorex.crypto.authds.avltree.batch._
   import scorex.crypto.hash.{Blake2b256, Digest32}
@@ -190,4 +190,30 @@ The code is under Public Domain CC0 license means you can do anything with it. F
 
 # Contributing
 
-Your contributions are always welcome! Please submit a pull request or create an issue to add a new cryptographic primitives or better implementations.
+Clone the repository
+```
+$git clone <repository> scrypto
+$cd scrypto
+```
+
+The code uses [Scalablytyped](https://scalablytyped.org/docs/readme) to generate Scala.js bindings
+for `@noble/hashes`. This [video](https://youtu.be/hWUAVrNj65c?t=1341) explains how the
+environment for ScalablyTyped is configured in this repository.
+
+Before compiling the library with SBT, you need to install JS dependencies for ScalablyTyped. 
+The configuration is in `package.json`.
+```
+$npm install
+added 285 packages, and audited 286 packages in 20s
+found 0 vulnerabilities
+```
+
+Then you can compile the library with SBT and run tests.
+```
+$sbt
+sbt:scrypto> compile
+sbt:scrypto> test
+```
+
+Your contributions are always welcome! 
+Please submit a pull request or create an issue to add a new cryptographic primitives or better implementations.

benchmarks/src/main/scala/scorex.benchmarks/Base16Benchmark.scala

@@ -45,12 +45,12 @@ object Base16Benchmark {
       .view
       .map(_ => Random.nextString(200).getBytes("UTF-8"))
       .map(Base16.encode)
-      .force
+      .force.toSeq
 
     val xab: Seq[Array[Byte]] = (1 to 1000)
       .view
       .map(_ => Random.nextString(200).getBytes("UTF-8"))
-      .force
+      .force.toSeq
   }
 
 }

benchmarks/src/main/scala/scorex.benchmarks/ByteArrayComparePerformance.scala

@@ -2,7 +2,7 @@ package scorex.benchmarks
 
 import java.util.concurrent.TimeUnit
 
-import com.google.common.primitives.Shorts
+import scorex.utils.Shorts
 import org.openjdk.jmh.annotations._
 import org.openjdk.jmh.infra.Blackhole
 import scorex.utils.ByteArray

benchmarks/src/main/scala/scorex.benchmarks/Helpers.scala

@@ -1,6 +1,6 @@
 package scorex.benchmarks
 
-import com.google.common.primitives.Longs
+import scorex.utils.Longs
 import scorex.crypto.authds.{ADKey, ADValue}
 import scorex.crypto.authds.avltree.batch.{BatchAVLProver, Insert, Operation, Remove}
 import scorex.crypto.hash.{Blake2b256, Digest32}

build.sbt

@@ -3,12 +3,9 @@ import sbt.Keys.{homepage, scalaVersion}
 name := "scrypto"
 description := "Cryptographic primitives for Scala"
 
+lazy val scala213 = "2.13.8"
 lazy val scala212 = "2.12.15"
 lazy val scala211 = "2.11.12"
-lazy val scala213 = "2.13.7"
-
-crossScalaVersions := Seq(scala212, scala211, scala213)
-scalaVersion := scala212
 
 javacOptions ++=
   "-source" :: "1.8" ::
@@ -34,48 +31,74 @@ lazy val commonSettings = Seq(
           "scm:git@github.com:input-output-hk/scrypto.git"
       )
   ),
+  libraryDependencies ++= Seq(
+    "org.rudogma" %%% "supertagged" % "2.0-RC2",
+    "org.scorexfoundation" %%% "scorex-util" % "0.1.8-20-565873cd-SNAPSHOT",
+    "org.scalatest" %%% "scalatest" % "3.3.0-SNAP3" % Test,
+    "org.scalatest" %%% "scalatest-propspec" % "3.3.0-SNAP3" % Test,
+    "org.scalatest" %%% "scalatest-shouldmatchers" % "3.3.0-SNAP3" % Test,
+    "org.scalatestplus" %%% "scalacheck-1-15" % "3.3.0.0-SNAP3" % Test,
+    "org.scalacheck" %%% "scalacheck" % "1.15.2" % Test
+  ),
+  publishMavenStyle := true,
+  publishTo := sonatypePublishToBundle.value
 )
 
-libraryDependencies ++= Seq(
-  "org.rudogma" %% "supertagged" % "1.5",
-  "com.google.guava" % "guava" % "23.0",
-  "com.typesafe.scala-logging" %% "scala-logging" % "3.9.2",
-  "org.whispersystems" % "curve25519-java" % "0.5.0",
-  "org.bouncycastle" % "bcprov-jdk15to18" % "1.66",
-  "org.scorexfoundation" %% "scorex-util" % "0.1.8"
-)
-
-libraryDependencies ++= Seq(
-  "org.scalatest" %% "scalatest" % "3.1.+" % Test,
-  "org.scalacheck" %% "scalacheck" % "1.14.+" % Test,
-  // https://mvnrepository.com/artifact/org.scalatestplus/scalatestplus-scalacheck
-  "org.scalatestplus" %% "scalatestplus-scalacheck" % "3.1.0.0-RC2" % Test
-)
-
-publishMavenStyle := true
 
-publishArtifact in Test := false
+Test / publishArtifact := false
 
-publishTo := sonatypePublishToBundle.value
 
 pomIncludeRepository := { _ => false }
 
-lazy val scrypto = (project in file(".")).settings(commonSettings: _*)
-
-lazy val benchmarks = (project in file("benchmarks"))
-  .settings(commonSettings, name := "scrypto-benchmarks")
-  .dependsOn(scrypto)
-  .enablePlugins(JmhPlugin)
+lazy val scrypto = crossProject(JVMPlatform, JSPlatform)
+    .in(file("."))
+    .settings(commonSettings: _*)
+    .jvmSettings(
+      libraryDependencies ++= Seq(
+        "org.bouncycastle" % "bcprov-jdk15to18" % "1.66"
+      ),
+      scalaVersion := scala213,
+      crossScalaVersions := Seq(scala211, scala212, scala213)
+    )
+
+lazy val scryptoJS = scrypto.js
+    .enablePlugins(ScalaJSBundlerPlugin)
+    .enablePlugins(ScalablyTypedConverterExternalNpmPlugin)
+    .settings(
+      scalaVersion := scala213,
+      crossScalaVersions := Seq(scala212, scala213),
+      libraryDependencies ++= Seq(
+        "org.scala-js" %%% "scala-js-macrotask-executor" % "1.0.0",
+        ("org.scala-js" %%% "scalajs-java-securerandom" % "1.0.0").cross(CrossVersion.for3Use2_13)
+      ),
+      Test / parallelExecution := false,
+      // how to setup ScalablyTyped https://youtu.be/hWUAVrNj65c?t=1341
+      externalNpm := { file(s"${baseDirectory.value}/..") },
+      Compile / npmDependencies ++= Seq(
+        "@noble/hashes" -> "^1.1.4"
+      ),
+      useYarn := true
+    )
+
+lazy val benchmarks = project
+    .in(file("benchmarks"))
+    .dependsOn(scrypto.jvm)
+    .settings(
+      moduleName := "scrypto-benchmarks",
+      crossScalaVersions := Seq(scala211, scala212, scala213),
+      scalaVersion := scala213,
+    )
+    .enablePlugins(JmhPlugin)
 
 credentials ++= (for {
   username <- Option(System.getenv().get("SONATYPE_USERNAME"))
   password <- Option(System.getenv().get("SONATYPE_PASSWORD"))
 } yield Credentials("Sonatype Nexus Repository Manager", "oss.sonatype.org", username, password)).toSeq
 
 // prefix version with "-SNAPSHOT" for builds without a git tag
-dynverSonatypeSnapshots in ThisBuild := true
+ThisBuild / dynverSonatypeSnapshots := true
 // use "-" instead of default "+"
-dynverSeparator in ThisBuild := "-"
+ThisBuild / dynverSeparator := "-"
 
 // PGP key for signing a release build published to sonatype
 // signing is done by sbt-pgp plugin

js/src/main/scala/scorex/crypto/hash/Platform.scala

@@ -0,0 +1,84 @@
+package scorex.crypto.hash
+
+import typings.nobleHashes.blake2Mod.BlakeOpts
+import typings.nobleHashes.mod.blake2b
+import typings.nobleHashes.sha256Mod.sha256
+import typings.nobleHashes.utilsMod
+
+import scala.scalajs.js.typedarray.Uint8Array
+
+/** JS platform specific implementation of methods.
+  * When shared code is compiled to JS, this implementation is used.
+  *
+  * The JS implementation is based on type wrappers generated by ScalablyTyped for the
+  * @noble/hashes library. (See configuration in build.sbt.)
+  *
+  * @see jvm/src/main/scala/scorex/crypto/hash/Platform.scala for JVM implementation
+  */
+object Platform {
+
+  /** Represents abstract digest from @noble.
+    * See createBlake2bDigest, createSha256Digest methods.
+    */
+  type Digest = utilsMod.Hash[_]
+
+  private def bytesToShorts(xs: Array[Byte]): Array[Short] =
+    xs.map(x => (x & 0xFF).toShort)
+
+  private def uint8ArrayToBytes(jsShorts: Uint8Array): Array[Byte] = {
+    jsShorts.toArray[Short].map(x => x.toByte)
+  }
+
+  /** Creates an implementation of the cryptographic hash function Blakbe2b.
+    *
+    * @param bitSize the bit size of the digest
+    * @return the digest implementation
+    */
+  def createBlake2bDigest(bitSize: Int): Digest = {
+    val opts = BlakeOpts().setDkLen(bitSize / 8)
+    blake2b.create(opts)
+  }
+
+  /** Creates an implementation of the cryptographic hash function SHA-256.
+    *
+    * @return the digest implementation
+    */
+  def createSha256Digest(): Digest = {
+    sha256.create()
+  }
+
+  /** Update the message digest with a single byte.
+    *
+    * @param digest the digest to be updated
+    * @param b      the input byte to be entered.
+    */
+  def updateDigest(digest: Digest, b: Byte): Unit = {
+    digest.update(Uint8Array.of((b & 0xFF).toShort))
+  }
+
+  /** Update the message digest with a block of bytes.
+    *
+    * @param digest the digest to be updated
+    * @param bytes     the byte array containing the data.
+    * @param inOff  the offset into the byte array where the data starts.
+    * @param inLen  the length of the data.
+    */
+  def updateDigest(digest: Digest,
+                   bytes: Array[Byte],
+                   inOff: Int,
+                   inLen: Int): Unit = {
+    val in = Uint8Array.of(bytesToShorts(bytes.slice(inOff, inOff + inLen)): _*)
+    digest.update(in)
+  }
+
+  /** Close the digest, producing the final digest value. The doFinal
+    * call leaves the digest reset.
+    * A new array is created to store the result.
+    *
+    * @param digest the digest to be finalized
+    */
+  def doFinalDigest(digest: Digest): Array[Byte] = {
+    val res = digest.digest()
+    uint8ArrayToBytes(res)
+  }
+}