Skip to content

Commit 568576a

Browse files
committed
feat(bindings): start Kotlin binding
1 parent c66a138 commit 568576a

File tree

15 files changed

+21753
-0
lines changed

15 files changed

+21753
-0
lines changed

bindings/kotlin/.gitattributes

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#
2+
# https://help.github.com/articles/dealing-with-line-endings/
3+
#
4+
# Linux start script should use lf
5+
/gradlew text eol=lf
6+
7+
# These are Windows script files and should use crlf
8+
*.bat text eol=crlf
9+
10+
# Binary files should be left untouched
11+
*.jar binary
12+

bindings/kotlin/.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Ignore Gradle project-specific cache directory
2+
.gradle
3+
4+
# Ignore Gradle build output directory
5+
build

bindings/kotlin/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Kotlin
2+
3+
## Generate Binding
4+
5+
```bash
6+
#!/bin/bash
7+
LANGUAGE="kotlin"
8+
# Start by building the library to generate the appropriate dylib files
9+
cargo build -p iota-sdk-ffi --lib --release
10+
# Determine the library extension based on the platform
11+
case "$(uname -s)" in
12+
Darwin) LIB_EXT=".dylib" ;;
13+
Linux) LIB_EXT=".so" ;;
14+
MINGW*|MSYS*|CYGWIN*|Windows_NT) LIB_EXT=".dll" ;;
15+
*) echo "Unsupported platform"; exit 1 ;;
16+
esac
17+
cargo run --bin iota_sdk_bindings -- generate --library "target/release/libiota_sdk_ffi${LIB_EXT}" --language $LANGUAGE --out-dir bindings/$LANGUAGE/lib --no-format
18+
#Finally, copy the library file to the output directory.
19+
cp target/release/libiota_sdk_ffi${LIB_EXT} bindings/$LANGUAGE/lib/
20+
```
21+
22+
# Run example
23+
24+
Install gradle:
25+
26+
```bash
27+
curl -s "https://get.sdkman.io" | bash
28+
source "$HOME/.sdkman/bin/sdkman-init.sh"
29+
sdk install gradle
30+
```
31+
32+
`java -version` should be >= 21
33+
34+
```bash
35+
cd bindings/kotlin
36+
37+
./gradlew build clean
38+
LD_LIBRARY_PATH=./lib ./gradlew run -q
39+
```

bindings/kotlin/build.gradle.kts

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
plugins {
2+
kotlin("jvm") version "1.9.24"
3+
application
4+
}
5+
6+
group = "org.iota"
7+
8+
version = "1.0-SNAPSHOT"
9+
10+
repositories { mavenCentral() }
11+
12+
dependencies {
13+
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3")
14+
implementation("net.java.dev.jna:jna:5.13.0")
15+
}
16+
17+
kotlin { jvmToolchain(21) }
18+
19+
application { mainClass.set("ExampleKt") }
20+
21+
sourceSets {
22+
main {
23+
kotlin { srcDirs("lib", "src/main/kotlin") }
24+
// Explicitly disable Java source sets since we only have Kotlin
25+
java { setSrcDirs(emptyList<String>()) }
26+
}
27+
}
28+
29+
// Add compiler configuration to handle UniFFI type conflicts
30+
tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
31+
kotlinOptions {
32+
jvmTarget = "21"
33+
freeCompilerArgs +=
34+
listOf(
35+
"-Xjvm-default=all",
36+
"-Xallow-kotlin-package",
37+
"-Xskip-prerelease-check",
38+
"-Xsuppress-version-warnings",
39+
"-Xno-param-assertions",
40+
"-Xno-call-assertions",
41+
"-Xno-receiver-assertions",
42+
// Add these flags to help with recursive type issues
43+
"-Xtype-enhancement-improvements-strict-mode=false",
44+
"-Xskip-runtime-version-check",
45+
"-Xlenient-function-type-parameter-checks"
46+
)
47+
allWarningsAsErrors = false
48+
suppressWarnings = true
49+
}
50+
}
51+
52+
// Alternative: Create a custom task that compiles with error tolerance
53+
tasks.register("compileWithErrors") {
54+
doLast {
55+
try {
56+
tasks.compileKotlin.get().actions.forEach { action ->
57+
action.execute(tasks.compileKotlin.get())
58+
}
59+
} catch (e: Exception) {
60+
println("Compilation completed with errors: ${e.message}")
61+
}
62+
}
63+
}

bindings/kotlin/gradle.properties

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# This file was generated by the Gradle 'init' task.
2+
# https://docs.gradle.org/current/userguide/build_environment.html#sec:gradle_configuration_properties
3+
4+
org.gradle.configuration-cache=true
5+
org.gradle.parallel=true
6+
org.gradle.caching=true
7+
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# This file was generated by the Gradle 'init' task.
2+
# https://docs.gradle.org/current/userguide/platforms.html#sub::toml-dependencies-format
3+
4+
[versions]
5+
kotlin-gradle-plugin = "2.1.20"
6+
7+
[libraries]
8+
kotlin-gradle-plugin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin-gradle-plugin" }
42.7 KB
Binary file not shown.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
distributionBase=GRADLE_USER_HOME
2+
distributionPath=wrapper/dists
3+
distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.2-bin.zip
4+
networkTimeout=10000
5+
validateDistributionUrl=true
6+
zipStoreBase=GRADLE_USER_HOME
7+
zipStorePath=wrapper/dists

bindings/kotlin/gradlew

Lines changed: 251 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,251 @@
1+
#!/bin/sh
2+
3+
#
4+
# Copyright © 2015-2021 the original authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#
18+
# SPDX-License-Identifier: Apache-2.0
19+
#
20+
21+
##############################################################################
22+
#
23+
# Gradle start up script for POSIX generated by Gradle.
24+
#
25+
# Important for running:
26+
#
27+
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
28+
# noncompliant, but you have some other compliant shell such as ksh or
29+
# bash, then to run this script, type that shell name before the whole
30+
# command line, like:
31+
#
32+
# ksh Gradle
33+
#
34+
# Busybox and similar reduced shells will NOT work, because this script
35+
# requires all of these POSIX shell features:
36+
# * functions;
37+
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
38+
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
39+
# * compound commands having a testable exit status, especially «case»;
40+
# * various built-in commands including «command», «set», and «ulimit».
41+
#
42+
# Important for patching:
43+
#
44+
# (2) This script targets any POSIX shell, so it avoids extensions provided
45+
# by Bash, Ksh, etc; in particular arrays are avoided.
46+
#
47+
# The "traditional" practice of packing multiple parameters into a
48+
# space-separated string is a well documented source of bugs and security
49+
# problems, so this is (mostly) avoided, by progressively accumulating
50+
# options in "$@", and eventually passing that to Java.
51+
#
52+
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
53+
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
54+
# see the in-line comments for details.
55+
#
56+
# There are tweaks for specific operating systems such as AIX, CygWin,
57+
# Darwin, MinGW, and NonStop.
58+
#
59+
# (3) This script is generated from the Groovy template
60+
# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
61+
# within the Gradle project.
62+
#
63+
# You can find Gradle at https://github.com/gradle/gradle/.
64+
#
65+
##############################################################################
66+
67+
# Attempt to set APP_HOME
68+
69+
# Resolve links: $0 may be a link
70+
app_path=$0
71+
72+
# Need this for daisy-chained symlinks.
73+
while
74+
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
75+
[ -h "$app_path" ]
76+
do
77+
ls=$( ls -ld "$app_path" )
78+
link=${ls#*' -> '}
79+
case $link in #(
80+
/*) app_path=$link ;; #(
81+
*) app_path=$APP_HOME$link ;;
82+
esac
83+
done
84+
85+
# This is normally unused
86+
# shellcheck disable=SC2034
87+
APP_BASE_NAME=${0##*/}
88+
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
89+
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
90+
91+
# Use the maximum available, or set MAX_FD != -1 to use that value.
92+
MAX_FD=maximum
93+
94+
warn () {
95+
echo "$*"
96+
} >&2
97+
98+
die () {
99+
echo
100+
echo "$*"
101+
echo
102+
exit 1
103+
} >&2
104+
105+
# OS specific support (must be 'true' or 'false').
106+
cygwin=false
107+
msys=false
108+
darwin=false
109+
nonstop=false
110+
case "$( uname )" in #(
111+
CYGWIN* ) cygwin=true ;; #(
112+
Darwin* ) darwin=true ;; #(
113+
MSYS* | MINGW* ) msys=true ;; #(
114+
NONSTOP* ) nonstop=true ;;
115+
esac
116+
117+
CLASSPATH="\\\"\\\""
118+
119+
120+
# Determine the Java command to use to start the JVM.
121+
if [ -n "$JAVA_HOME" ] ; then
122+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
123+
# IBM's JDK on AIX uses strange locations for the executables
124+
JAVACMD=$JAVA_HOME/jre/sh/java
125+
else
126+
JAVACMD=$JAVA_HOME/bin/java
127+
fi
128+
if [ ! -x "$JAVACMD" ] ; then
129+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
130+
131+
Please set the JAVA_HOME variable in your environment to match the
132+
location of your Java installation."
133+
fi
134+
else
135+
JAVACMD=java
136+
if ! command -v java >/dev/null 2>&1
137+
then
138+
die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
139+
140+
Please set the JAVA_HOME variable in your environment to match the
141+
location of your Java installation."
142+
fi
143+
fi
144+
145+
# Increase the maximum file descriptors if we can.
146+
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
147+
case $MAX_FD in #(
148+
max*)
149+
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
150+
# shellcheck disable=SC2039,SC3045
151+
MAX_FD=$( ulimit -H -n ) ||
152+
warn "Could not query maximum file descriptor limit"
153+
esac
154+
case $MAX_FD in #(
155+
'' | soft) :;; #(
156+
*)
157+
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
158+
# shellcheck disable=SC2039,SC3045
159+
ulimit -n "$MAX_FD" ||
160+
warn "Could not set maximum file descriptor limit to $MAX_FD"
161+
esac
162+
fi
163+
164+
# Collect all arguments for the java command, stacking in reverse order:
165+
# * args from the command line
166+
# * the main class name
167+
# * -classpath
168+
# * -D...appname settings
169+
# * --module-path (only if needed)
170+
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
171+
172+
# For Cygwin or MSYS, switch paths to Windows format before running java
173+
if "$cygwin" || "$msys" ; then
174+
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
175+
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
176+
177+
JAVACMD=$( cygpath --unix "$JAVACMD" )
178+
179+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
180+
for arg do
181+
if
182+
case $arg in #(
183+
-*) false ;; # don't mess with options #(
184+
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
185+
[ -e "$t" ] ;; #(
186+
*) false ;;
187+
esac
188+
then
189+
arg=$( cygpath --path --ignore --mixed "$arg" )
190+
fi
191+
# Roll the args list around exactly as many times as the number of
192+
# args, so each arg winds up back in the position where it started, but
193+
# possibly modified.
194+
#
195+
# NB: a `for` loop captures its iteration list before it begins, so
196+
# changing the positional parameters here affects neither the number of
197+
# iterations, nor the values presented in `arg`.
198+
shift # remove old arg
199+
set -- "$@" "$arg" # push replacement arg
200+
done
201+
fi
202+
203+
204+
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
205+
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
206+
207+
# Collect all arguments for the java command:
208+
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
209+
# and any embedded shellness will be escaped.
210+
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
211+
# treated as '${Hostname}' itself on the command line.
212+
213+
set -- \
214+
"-Dorg.gradle.appname=$APP_BASE_NAME" \
215+
-classpath "$CLASSPATH" \
216+
-jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
217+
"$@"
218+
219+
# Stop when "xargs" is not available.
220+
if ! command -v xargs >/dev/null 2>&1
221+
then
222+
die "xargs is not available"
223+
fi
224+
225+
# Use "xargs" to parse quoted args.
226+
#
227+
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
228+
#
229+
# In Bash we could simply go:
230+
#
231+
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
232+
# set -- "${ARGS[@]}" "$@"
233+
#
234+
# but POSIX shell has neither arrays nor command substitution, so instead we
235+
# post-process each arg (as a line of input to sed) to backslash-escape any
236+
# character that might be a shell metacharacter, then use eval to reverse
237+
# that process (while maintaining the separation between arguments), and wrap
238+
# the whole thing up as a single "set" statement.
239+
#
240+
# This will of course break if any of these variables contains a newline or
241+
# an unmatched quote.
242+
#
243+
244+
eval "set -- $(
245+
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
246+
xargs -n1 |
247+
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
248+
tr '\n' ' '
249+
)" '"$@"'
250+
251+
exec "$JAVACMD" "$@"

0 commit comments

Comments
 (0)