diff --git a/README.md b/README.md index 16eb8cb..118f0d1 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,46 @@ This project will contain samples of API usage for the [UnitedGold](https://dev.unitedgold.io) project. +## [kmp_console](kmp_console): native and JVM console app -- [jvm_console](jvm_console) simple JVM console application +simple JVM/Native console sample application. +### jvm variant + + ./gradlew kmp_console:runJvm + +You can create distribution with + + ./gradlew kmp_console:installJvmDist + +You will find it in the ./kmp_console/build/install/kmp_console-jvm: the whole file tree is needed. You can rain it from command line with + + ./kmp_console/build/install/kmp_console-jvm/bin/kmp_console + +or, on windows, + + ./kmp_console/build/install/kmp_console-jvm/bin/kmp_console.bat + +This distribution only needs JDK be installed, like OpenJDK 17+ or Amazon Coretto 17+. It still will be much larger, even zipped, than native variant below. + + +### Linux x64 console + + ./gradlew kmp_console:runDebugExecutableLinuxX64 + +To create standalone binary executable for linux x64: + + ./gradlew kmp_console:linkReleaseExecutableLinuxX64 + +The file is created is ./kmp_console//build/bin/linuxX64/releaseExecutable/kmp_console.kexe - to run it + + ./kmp_console//build/bin/linuxX64/releaseExecutable/kmp_console.kexe + +You can reduce its size as usually with KMP natives by stripping and upxing it: + + strip ./kmp_console//build/bin/linuxX64/releaseExecutable/kmp_console.kexe + upx ./kmp_console//build/bin/linuxX64/releaseExecutable/kmp_console.kexe + +Now it should have sane size, considering how many features are packed inside (most of it not seen directly, as heavy encrypted parsec3 protocol). + +This way you can create dependency-free server tools. \ No newline at end of file diff --git a/build.gradle.kts b/build.gradle.kts index 785db1b..be63578 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -2,4 +2,7 @@ unitedgold.io samples - */ \ No newline at end of file + */ +plugins { + id("org.jetbrains.kotlin.multiplatform") version("2.1.21") apply false +} \ No newline at end of file diff --git a/jvm_console/.gitignore b/jvm_console/.gitignore deleted file mode 100644 index b1dff0d..0000000 --- a/jvm_console/.gitignore +++ /dev/null @@ -1,45 +0,0 @@ -.gradle -build/ -!gradle/wrapper/gradle-wrapper.jar -!**/src/main/**/build/ -!**/src/test/**/build/ - -### IntelliJ IDEA ### -.idea/modules.xml -.idea/jarRepositories.xml -.idea/compiler.xml -.idea/libraries/ -*.iws -*.iml -*.ipr -out/ -!**/src/main/**/out/ -!**/src/test/**/out/ - -### Kotlin ### -.kotlin - -### Eclipse ### -.apt_generated -.classpath -.factorypath -.project -.settings -.springBeans -.sts4-cache -bin/ -!**/src/main/**/bin/ -!**/src/test/**/bin/ - -### NetBeans ### -/nbproject/private/ -/nbbuild/ -/dist/ -/nbdist/ -/.nb-gradle/ - -### VS Code ### -.vscode/ - -### Mac OS ### -.DS_Store \ No newline at end of file diff --git a/jvm_console/README.md b/jvm_console/README.md deleted file mode 100644 index 70ac940..0000000 --- a/jvm_console/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# unitedgold.io JVM console sample - -This project will contain samples of API usage for the [UnitedGold](https://dev.unitedgold.io) project. - -This sample shows how to configure and connect APU library, create connection to the server and perform most basic operations. diff --git a/jvm_console/build.gradle.kts b/jvm_console/build.gradle.kts deleted file mode 100644 index 2819ff0..0000000 --- a/jvm_console/build.gradle.kts +++ /dev/null @@ -1,37 +0,0 @@ -plugins { - kotlin("jvm") version "2.0.10" -} - -group = "io.unitedgold" -version = "1.0-SNAPSHOT" - -repositories { - mavenCentral() - - // 3 custom repositories for unitedgold.io components: - maven("https://gitea.sergeych.net/api/packages/SergeychWorks/maven") - maven("https://maven.universablockchain.com") - maven("https://gitea.sergeych.net/api/packages/YoungBlood/maven") - // end of unitedgold.io required repositories -} - -val apiVersion = "0.0.1-SNAPSHOT" - -dependencies { - // The API library - implementation("io.unitedgold.api:shared:$apiVersion") - - // To silence logback error messages of "not being configured", - // this is Ktor client issue (we use ktor client in API) - implementation("ch.qos.logback:logback-classic:1.5.18") - - testImplementation(kotlin("test")) -} - -tasks.test { - useJUnitPlatform() -} - -kotlin { - jvmToolchain(17) -} \ No newline at end of file diff --git a/jvm_console/gradle.properties b/jvm_console/gradle.properties deleted file mode 100644 index 7fc6f1f..0000000 --- a/jvm_console/gradle.properties +++ /dev/null @@ -1 +0,0 @@ -kotlin.code.style=official diff --git a/jvm_console/gradle/wrapper/gradle-wrapper.jar b/jvm_console/gradle/wrapper/gradle-wrapper.jar deleted file mode 100644 index 249e583..0000000 Binary files a/jvm_console/gradle/wrapper/gradle-wrapper.jar and /dev/null differ diff --git a/jvm_console/gradle/wrapper/gradle-wrapper.properties b/jvm_console/gradle/wrapper/gradle-wrapper.properties deleted file mode 100644 index f8ea9c4..0000000 --- a/jvm_console/gradle/wrapper/gradle-wrapper.properties +++ /dev/null @@ -1,6 +0,0 @@ -#Tue Sep 16 14:42:49 GST 2025 -distributionBase=GRADLE_USER_HOME -distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip -zipStoreBase=GRADLE_USER_HOME -zipStorePath=wrapper/dists diff --git a/jvm_console/gradlew b/jvm_console/gradlew deleted file mode 100755 index 1b6c787..0000000 --- a/jvm_console/gradlew +++ /dev/null @@ -1,234 +0,0 @@ -#!/bin/sh - -# -# Copyright © 2015-2021 the original authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -############################################################################## -# -# Gradle start up script for POSIX generated by Gradle. -# -# Important for running: -# -# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is -# noncompliant, but you have some other compliant shell such as ksh or -# bash, then to run this script, type that shell name before the whole -# command line, like: -# -# ksh Gradle -# -# Busybox and similar reduced shells will NOT work, because this script -# requires all of these POSIX shell features: -# * functions; -# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», -# «${var#prefix}», «${var%suffix}», and «$( cmd )»; -# * compound commands having a testable exit status, especially «case»; -# * various built-in commands including «command», «set», and «ulimit». -# -# Important for patching: -# -# (2) This script targets any POSIX shell, so it avoids extensions provided -# by Bash, Ksh, etc; in particular arrays are avoided. -# -# The "traditional" practice of packing multiple parameters into a -# space-separated string is a well documented source of bugs and security -# problems, so this is (mostly) avoided, by progressively accumulating -# options in "$@", and eventually passing that to Java. -# -# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, -# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; -# see the in-line comments for details. -# -# There are tweaks for specific operating systems such as AIX, CygWin, -# Darwin, MinGW, and NonStop. -# -# (3) This script is generated from the Groovy template -# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt -# within the Gradle project. -# -# You can find Gradle at https://github.com/gradle/gradle/. -# -############################################################################## - -# Attempt to set APP_HOME - -# Resolve links: $0 may be a link -app_path=$0 - -# Need this for daisy-chained symlinks. -while - APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path - [ -h "$app_path" ] -do - ls=$( ls -ld "$app_path" ) - link=${ls#*' -> '} - case $link in #( - /*) app_path=$link ;; #( - *) app_path=$APP_HOME$link ;; - esac -done - -APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit - -APP_NAME="Gradle" -APP_BASE_NAME=${0##*/} - -# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' - -# Use the maximum available, or set MAX_FD != -1 to use that value. -MAX_FD=maximum - -warn () { - echo "$*" -} >&2 - -die () { - echo - echo "$*" - echo - exit 1 -} >&2 - -# OS specific support (must be 'true' or 'false'). -cygwin=false -msys=false -darwin=false -nonstop=false -case "$( uname )" in #( - CYGWIN* ) cygwin=true ;; #( - Darwin* ) darwin=true ;; #( - MSYS* | MINGW* ) msys=true ;; #( - NONSTOP* ) nonstop=true ;; -esac - -CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar - - -# Determine the Java command to use to start the JVM. -if [ -n "$JAVA_HOME" ] ; then - if [ -x "$JAVA_HOME/jre/sh/java" ] ; then - # IBM's JDK on AIX uses strange locations for the executables - JAVACMD=$JAVA_HOME/jre/sh/java - else - JAVACMD=$JAVA_HOME/bin/java - fi - if [ ! -x "$JAVACMD" ] ; then - die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME - -Please set the JAVA_HOME variable in your environment to match the -location of your Java installation." - fi -else - JAVACMD=java - which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. - -Please set the JAVA_HOME variable in your environment to match the -location of your Java installation." -fi - -# Increase the maximum file descriptors if we can. -if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then - case $MAX_FD in #( - max*) - MAX_FD=$( ulimit -H -n ) || - warn "Could not query maximum file descriptor limit" - esac - case $MAX_FD in #( - '' | soft) :;; #( - *) - ulimit -n "$MAX_FD" || - warn "Could not set maximum file descriptor limit to $MAX_FD" - esac -fi - -# Collect all arguments for the java command, stacking in reverse order: -# * args from the command line -# * the main class name -# * -classpath -# * -D...appname settings -# * --module-path (only if needed) -# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. - -# For Cygwin or MSYS, switch paths to Windows format before running java -if "$cygwin" || "$msys" ; then - APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) - CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) - - JAVACMD=$( cygpath --unix "$JAVACMD" ) - - # Now convert the arguments - kludge to limit ourselves to /bin/sh - for arg do - if - case $arg in #( - -*) false ;; # don't mess with options #( - /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath - [ -e "$t" ] ;; #( - *) false ;; - esac - then - arg=$( cygpath --path --ignore --mixed "$arg" ) - fi - # Roll the args list around exactly as many times as the number of - # args, so each arg winds up back in the position where it started, but - # possibly modified. - # - # NB: a `for` loop captures its iteration list before it begins, so - # changing the positional parameters here affects neither the number of - # iterations, nor the values presented in `arg`. - shift # remove old arg - set -- "$@" "$arg" # push replacement arg - done -fi - -# Collect all arguments for the java command; -# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of -# shell script including quotes and variable substitutions, so put them in -# double quotes to make sure that they get re-expanded; and -# * put everything else in single quotes, so that it's not re-expanded. - -set -- \ - "-Dorg.gradle.appname=$APP_BASE_NAME" \ - -classpath "$CLASSPATH" \ - org.gradle.wrapper.GradleWrapperMain \ - "$@" - -# Use "xargs" to parse quoted args. -# -# With -n1 it outputs one arg per line, with the quotes and backslashes removed. -# -# In Bash we could simply go: -# -# readarray ARGS < <( xargs -n1 <<<"$var" ) && -# set -- "${ARGS[@]}" "$@" -# -# but POSIX shell has neither arrays nor command substitution, so instead we -# post-process each arg (as a line of input to sed) to backslash-escape any -# character that might be a shell metacharacter, then use eval to reverse -# that process (while maintaining the separation between arguments), and wrap -# the whole thing up as a single "set" statement. -# -# This will of course break if any of these variables contains a newline or -# an unmatched quote. -# - -eval "set -- $( - printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | - xargs -n1 | - sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | - tr '\n' ' ' - )" '"$@"' - -exec "$JAVACMD" "$@" diff --git a/jvm_console/gradlew.bat b/jvm_console/gradlew.bat deleted file mode 100644 index 107acd3..0000000 --- a/jvm_console/gradlew.bat +++ /dev/null @@ -1,89 +0,0 @@ -@rem -@rem Copyright 2015 the original author or authors. -@rem -@rem Licensed under the Apache License, Version 2.0 (the "License"); -@rem you may not use this file except in compliance with the License. -@rem You may obtain a copy of the License at -@rem -@rem https://www.apache.org/licenses/LICENSE-2.0 -@rem -@rem Unless required by applicable law or agreed to in writing, software -@rem distributed under the License is distributed on an "AS IS" BASIS, -@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -@rem See the License for the specific language governing permissions and -@rem limitations under the License. -@rem - -@if "%DEBUG%" == "" @echo off -@rem ########################################################################## -@rem -@rem Gradle startup script for Windows -@rem -@rem ########################################################################## - -@rem Set local scope for the variables with windows NT shell -if "%OS%"=="Windows_NT" setlocal - -set DIRNAME=%~dp0 -if "%DIRNAME%" == "" set DIRNAME=. -set APP_BASE_NAME=%~n0 -set APP_HOME=%DIRNAME% - -@rem Resolve any "." and ".." in APP_HOME to make it shorter. -for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi - -@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" - -@rem Find java.exe -if defined JAVA_HOME goto findJavaFromJavaHome - -set JAVA_EXE=java.exe -%JAVA_EXE% -version >NUL 2>&1 -if "%ERRORLEVEL%" == "0" goto execute - -echo. -echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. - -goto fail - -:findJavaFromJavaHome -set JAVA_HOME=%JAVA_HOME:"=% -set JAVA_EXE=%JAVA_HOME%/bin/java.exe - -if exist "%JAVA_EXE%" goto execute - -echo. -echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. - -goto fail - -:execute -@rem Setup the command line - -set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar - - -@rem Execute Gradle -"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* - -:end -@rem End local scope for the variables with windows NT shell -if "%ERRORLEVEL%"=="0" goto mainEnd - -:fail -rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of -rem the _cmd.exe /c_ return code! -if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 -exit /b 1 - -:mainEnd -if "%OS%"=="Windows_NT" endlocal - -:omega diff --git a/jvm_console/settings.gradle.kts b/jvm_console/settings.gradle.kts deleted file mode 100644 index 2d254d2..0000000 --- a/jvm_console/settings.gradle.kts +++ /dev/null @@ -1,4 +0,0 @@ -plugins { - id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0" -} - diff --git a/jvm_console/src/main/kotlin/Main.kt b/kmp_console/src/commonMain/kotlin/CommonMain.kt similarity index 59% rename from jvm_console/src/main/kotlin/Main.kt rename to kmp_console/src/commonMain/kotlin/CommonMain.kt index 59b34a5..58ef12b 100644 --- a/jvm_console/src/main/kotlin/Main.kt +++ b/kmp_console/src/commonMain/kotlin/CommonMain.kt @@ -1,10 +1,15 @@ -package io.unitedgold - import kotlinx.coroutines.runBlocking import net.sergeych.crypto2.initCrypto +import net.sergeych.mp_logger.Log import net.sergeych.ugdx.UGClient -fun main() { +// The actual application code, which is called from +// the main function if the corresponding platform +fun commonMain() { + + // It is simetimes interesting to see what happens under the hood. + // uncomment out this string to reduce debug noise: + //Log.connectConsole(Log.Level.DEBUG) // united gold API is coroutine-based; this way it can effectively // run ell on single-thread platforms like JS aor WasmJS, but it comes @@ -18,11 +23,12 @@ fun main() { // create a client connection using WebSocket to the dev server val client = UGClient("wss://dev.unitedgold.io/kp") - // enumerate all currencies - for( cp in client.currencyPairs() ) { + // enumerate all trading paris + println("-------- trading pairs --------") + for( tradingPair in client.tradingPairs() ) { // label is short text like "UBIT/USDX" // them we output longer token names: - println("${cp.label}: ${cp.base.name} / ${cp.quote.name}") + println("${tradingPair.label}: ${tradingPair.base.name} / ${tradingPair.quote.name}") } } diff --git a/jvm_console/src/main/resources/logback.xml b/kmp_console/src/commonMain/resources/logback.xml similarity index 100% rename from jvm_console/src/main/resources/logback.xml rename to kmp_console/src/commonMain/resources/logback.xml diff --git a/kmp_console/src/jvmMain/kotlin/io/unitedgold/samples/console/Main.kt b/kmp_console/src/jvmMain/kotlin/io/unitedgold/samples/console/Main.kt new file mode 100644 index 0000000..3c5d40e --- /dev/null +++ b/kmp_console/src/jvmMain/kotlin/io/unitedgold/samples/console/Main.kt @@ -0,0 +1,7 @@ +package io.unitedgold.samples.console + +import commonMain + +fun main() { + commonMain() +} \ No newline at end of file diff --git a/kmp_console/src/linuxX64Main/kotlin/Main.kt b/kmp_console/src/linuxX64Main/kotlin/Main.kt new file mode 100644 index 0000000..98d6c98 --- /dev/null +++ b/kmp_console/src/linuxX64Main/kotlin/Main.kt @@ -0,0 +1,3 @@ +fun main(args: Array) { + commonMain() +} \ No newline at end of file diff --git a/settings.gradle.kts b/settings.gradle.kts index 670a2f5..5dd8b45 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -1,3 +1,21 @@ rootProject.name = "unitedgold_samples" -include(":jvm_console") +pluginManagement { + repositories { + google() + mavenCentral() + gradlePluginPortal() + } +} + +dependencyResolutionManagement { + repositories { + google() + mavenCentral() + maven("https://maven.universablockchain.com/") + maven("https://gitea.sergeych.net/api/packages/SergeychWorks/maven") + mavenLocal() + } +} + +include("kmp_console")