-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #60 from input-output-hk/feature/var-int
Feature - VarInt
- Loading branch information
Showing
9 changed files
with
341 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # Apollo - VarInt | ||
|
|
||
| [](http://kotlinlang.org) | ||
| [](https://github.com/input-output-hk/atala-prism-apollo/actions/workflows/pull-request.yml) | ||
| [](https://github.com/input-output-hk/atala-prism-apollo/actions/workflows/Deployment.yml) | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
|  | ||
|
|
||
| Apollo VarInt is Kotlin Multiplatform library implementation of [VarInt](https://github.com/multiformats/unsigned-varint) unsigned varint (VARiable INTeger) format. | ||
|
|
||
| ## Usage | ||
|
|
||
| ```kotlin | ||
| val originValue = 1234774 | ||
| val byteBuffer = Buffer() | ||
| VarInt.write(originValue, byteBuffer) | ||
| val value: Int = VarInt.read(byteBuffer) | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,215 @@ | ||
| import org.gradle.internal.os.OperatingSystem | ||
| import org.jetbrains.dokka.gradle.DokkaTask | ||
| import org.jetbrains.kotlin.gradle.targets.js.webpack.KotlinWebpackOutput.Target | ||
|
|
||
| version = rootProject.version | ||
| val currentModuleName = "ApolloVarInt" | ||
| val os: OperatingSystem = OperatingSystem.current() | ||
|
|
||
| plugins { | ||
| kotlin("multiplatform") | ||
| kotlin("native.cocoapods") | ||
| id("com.android.library") | ||
| id("org.jetbrains.dokka") | ||
| } | ||
|
|
||
| kotlin { | ||
| android { | ||
| publishAllLibraryVariants() | ||
| } | ||
| jvm { | ||
| compilations.all { | ||
| kotlinOptions { | ||
| jvmTarget = "11" | ||
| } | ||
| } | ||
| testRuns["test"].executionTask.configure { | ||
| useJUnitPlatform() | ||
| } | ||
| } | ||
| if (os.isMacOsX) { | ||
| ios() | ||
| // tvos() | ||
| // watchos() | ||
| // macosX64() | ||
| if (System.getProperty("os.arch") != "x86_64") { // M1Chip | ||
| iosSimulatorArm64() | ||
| // tvosSimulatorArm64() | ||
| // watchosSimulatorArm64() | ||
| // macosArm64() | ||
| } | ||
| } | ||
| // if (os.isWindows) { | ||
| // // mingwX86() // it depend on kotlinx-datetime lib to support this platform before we can support it as well | ||
| // mingwX64() | ||
| // } | ||
| js(IR) { | ||
| this.moduleName = currentModuleName | ||
| this.binaries.library() | ||
| this.useCommonJs() | ||
| this.compilations["main"].packageJson { | ||
| this.version = rootProject.version.toString() | ||
| } | ||
| this.compilations["test"].packageJson { | ||
| this.version = rootProject.version.toString() | ||
| } | ||
| browser { | ||
| this.webpackTask { | ||
| this.output.library = currentModuleName | ||
| this.output.libraryTarget = Target.VAR | ||
| } | ||
| this.commonWebpackConfig { | ||
| this.cssSupport { | ||
| this.enabled = true | ||
| } | ||
| } | ||
| this.testTask { | ||
| this.useKarma { | ||
| this.useChromeHeadless() | ||
| } | ||
| } | ||
| } | ||
| nodejs { | ||
| this.testTask { | ||
| this.useKarma { | ||
| this.useChromeHeadless() | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if (os.isMacOsX) { | ||
| cocoapods { | ||
| this.summary = "ApolloVarInt is VarInt" | ||
| this.version = rootProject.version.toString() | ||
| this.authors = "IOG" | ||
| this.ios.deploymentTarget = "13.0" | ||
| this.osx.deploymentTarget = "12.0" | ||
| this.tvos.deploymentTarget = "13.0" | ||
| this.watchos.deploymentTarget = "8.0" | ||
| framework { | ||
| this.baseName = currentModuleName | ||
| } | ||
| } | ||
| } | ||
|
|
||
| sourceSets { | ||
| val commonMain by getting { | ||
| dependencies { | ||
| implementation("com.squareup.okio:okio:3.2.0") | ||
| } | ||
| } | ||
| val commonTest by getting { | ||
| dependencies { | ||
| implementation(kotlin("test")) | ||
| } | ||
| } | ||
| val jvmMain by getting | ||
| val jvmTest by getting { | ||
| dependencies { | ||
| implementation("junit:junit:4.13.2") | ||
| } | ||
| } | ||
| val androidMain by getting | ||
| val androidTest by getting { | ||
| dependencies { | ||
| implementation("junit:junit:4.13.2") | ||
| } | ||
| } | ||
| val jsMain by getting | ||
| val jsTest by getting | ||
| if (os.isMacOsX) { | ||
| val iosMain by getting | ||
| val iosTest by getting | ||
| // val tvosMain by getting | ||
| // val tvosTest by getting | ||
| // val watchosMain by getting | ||
| // val watchosTest by getting | ||
| // val macosX64Main by getting | ||
| // val macosX64Test by getting | ||
| if (System.getProperty("os.arch") != "x86_64") { // M1Chip | ||
| val iosSimulatorArm64Main by getting { | ||
| this.dependsOn(iosMain) | ||
| } | ||
| val iosSimulatorArm64Test by getting { | ||
| this.dependsOn(iosTest) | ||
| } | ||
| // val tvosSimulatorArm64Main by getting { | ||
| // this.dependsOn(tvosMain) | ||
| // } | ||
| // val tvosSimulatorArm64Test by getting { | ||
| // this.dependsOn(tvosTest) | ||
| // } | ||
| // val watchosSimulatorArm64Main by getting { | ||
| // this.dependsOn(watchosMain) | ||
| // } | ||
| // val watchosSimulatorArm64Test by getting { | ||
| // this.dependsOn(watchosTest) | ||
| // } | ||
| // val macosArm64Main by getting { | ||
| // this.dependsOn(macosX64Main) | ||
| // } | ||
| // val macosArm64Test by getting { | ||
| // this.dependsOn(macosX64Test) | ||
| // } | ||
| } | ||
| } | ||
| // if (os.isWindows) { | ||
| // // val mingwX86Main by getting // it depend on kotlinx-datetime lib to support this platform before we can support it as well | ||
| // // val mingwX86Test by getting // it depend on kotlinx-datetime lib to support this platform before we can support it as well | ||
| // val mingwX64Main by getting | ||
| // val mingwX64Test by getting | ||
| // } | ||
| } | ||
| } | ||
|
|
||
| android { | ||
| compileSdk = 32 | ||
| sourceSets["main"].manifest.srcFile("src/androidMain/AndroidManifest.xml") | ||
| defaultConfig { | ||
| minSdk = 21 | ||
| targetSdk = 32 | ||
| } | ||
| compileOptions { | ||
| sourceCompatibility = JavaVersion.VERSION_11 | ||
| targetCompatibility = JavaVersion.VERSION_11 | ||
| } | ||
| /** | ||
| * Because Software Components will not be created automatically for Maven publishing from | ||
| * Android Gradle Plugin 8.0. To opt-in to the future behavior, set the Gradle property android. | ||
| * disableAutomaticComponentCreation=true in the `gradle.properties` file or use the new | ||
| * publishing DSL. | ||
| */ | ||
| publishing { | ||
| multipleVariants { | ||
| withSourcesJar() | ||
| withJavadocJar() | ||
| allVariants() | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Dokka implementation | ||
| tasks.withType<DokkaTask> { | ||
| moduleName.set(project.name) | ||
| moduleVersion.set(rootProject.version.toString()) | ||
| description = """ | ||
| This is a Kotlin Multiplatform Library for ECDSA | ||
| """.trimIndent() | ||
| dokkaSourceSets { | ||
| // TODO: Figure out how to include files to the documentations | ||
| named("commonMain") { | ||
| includes.from("Module.md", "docs/Module.md") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // afterEvaluate { | ||
| // tasks.withType<AbstractTestTask> { | ||
| // testLogging { | ||
| // events("passed", "skipped", "failed", "standard_out", "standard_error") | ||
| // showExceptions = true | ||
| // showStackTraces = true | ||
| // } | ||
| // } | ||
| // } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <manifest package="io.iohk.atala.prism.apollo.varint" /> |
29 changes: 29 additions & 0 deletions
29
varint/src/commonMain/kotlin/io/iohk/atala/prism/apollo/varint/VarInt.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| package io.iohk.atala.prism.apollo.varint | ||
|
|
||
| import okio.Buffer | ||
|
|
||
| object VarInt : VarIntInterface { | ||
| override fun write(value: Int, byteBuffer: Buffer) { | ||
| var value = value | ||
| while ((value and -0x80).toLong() != 0L) { | ||
| byteBuffer.writeByte(value and 0x7F or 0x80) | ||
| value = value ushr 7 | ||
| } | ||
| byteBuffer.writeByte(value and 0x7F) | ||
| } | ||
|
|
||
| override fun read(byteBuffer: Buffer): Int { | ||
| var value = 0 | ||
| var i = 0 | ||
| var b = 0 | ||
| while (byteBuffer.size > 0 && byteBuffer.readByte().toInt().also { b = it } and 0x80 != 0) { | ||
| value = value or (b and 0x7F shl i) | ||
| i += 7 | ||
| if (i > 35) { | ||
| throw IllegalArgumentException("Variable length quantity is too long") | ||
| } | ||
| } | ||
| value = value or (b shl i) | ||
| return value | ||
| } | ||
| } |
8 changes: 8 additions & 0 deletions
8
varint/src/commonMain/kotlin/io/iohk/atala/prism/apollo/varint/VarIntInterface.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| package io.iohk.atala.prism.apollo.varint | ||
|
|
||
| import okio.Buffer | ||
|
|
||
| interface VarIntInterface { | ||
| fun write(value: Int, byteBuffer: Buffer) | ||
| fun read(byteBuffer: Buffer): Int | ||
| } |
16 changes: 16 additions & 0 deletions
16
varint/src/commonTest/kotlin/io/iohk/atala/prism/apollo/varint/VarIntTests.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| package io.iohk.atala.prism.apollo.varint | ||
|
|
||
| import okio.Buffer | ||
| import kotlin.test.Test | ||
| import kotlin.test.assertEquals | ||
|
|
||
| class VarIntTests { | ||
| @Test | ||
| fun testVarInt() { | ||
| val origin = 1234774 | ||
| val byteBuffer = Buffer() | ||
| VarInt.write(origin, byteBuffer) | ||
| val value: Int = VarInt.read(byteBuffer) | ||
| assertEquals(origin, value) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| Pod::Spec.new do |spec| | ||
| spec.name = 'varint' | ||
| spec.version = '1.0.0-alpha' | ||
| spec.homepage = '' | ||
| spec.source = { :http=> ''} | ||
| spec.authors = 'IOG' | ||
| spec.license = '' | ||
| spec.summary = 'ApolloVarInt is VarInt' | ||
| spec.vendored_frameworks = 'build/cocoapods/framework/ApolloVarInt.framework' | ||
| spec.libraries = 'c++' | ||
| spec.ios.deployment_target = '13.0' | ||
| spec.osx.deployment_target = '12.0' | ||
| spec.tvos.deployment_target = '13.0' | ||
| spec.watchos.deployment_target = '8.0' | ||
|
|
||
|
|
||
| spec.pod_target_xcconfig = { | ||
| 'KOTLIN_PROJECT_PATH' => ':varint', | ||
| 'PRODUCT_MODULE_NAME' => 'ApolloVarInt', | ||
| } | ||
|
|
||
| spec.script_phases = [ | ||
| { | ||
| :name => 'Build varint', | ||
| :execution_position => :before_compile, | ||
| :shell_path => '/bin/sh', | ||
| :script => <<-SCRIPT | ||
| if [ "YES" = "$OVERRIDE_KOTLIN_BUILD_IDE_SUPPORTED" ]; then | ||
| echo "Skipping Gradle build task invocation due to OVERRIDE_KOTLIN_BUILD_IDE_SUPPORTED environment variable set to \"YES\"" | ||
| exit 0 | ||
| fi | ||
| set -ev | ||
| REPO_ROOT="$PODS_TARGET_SRCROOT" | ||
| "$REPO_ROOT/../gradlew" -p "$REPO_ROOT" $KOTLIN_PROJECT_PATH:syncFramework \ | ||
| -Pkotlin.native.cocoapods.platform=$PLATFORM_NAME \ | ||
| -Pkotlin.native.cocoapods.archs="$ARCHS" \ | ||
| -Pkotlin.native.cocoapods.configuration="$CONFIGURATION" | ||
| SCRIPT | ||
| } | ||
| ] | ||
|
|
||
| end |