Rust	Kotlin	Swift	Average

Sargon is library for sharing code between Radix iOS/Android wallets.

Named after Sargon of Akkad the first ruler of the Akkadian Empire, the first empire of Mesopotamia. Babylon was a city in southern Mesopotamia, and of course the name of the Radix milestone with which the Radix wallets was launched.

We recommend installing the Radix Transaction Manifest Extension for VS Code if you use that IDE

For VS Code IDE users, we recommend installing the Rust snippet vendored with this repo:

./scripts/install_snippets.sh

xcode-select --install

Or install Xcode from App Store

brew install kotlin

Recommended to use pre-commit tool

brew install pre-commit

This repo contains a .pre-commit-config.yaml which uses the amazing typos tool, you MUST INSTALL the config, do it by:

pre-commit install

Nextest is a nice test runner for Rust!

cargo install cargo-nextest

Recommended to use tarpaulin tool for code coverage:

cargo install cargo-tarpaulin

And then run:

cargo tarpaulin --out Html

cargo nextest run

rustup target add aarch64-apple-ios aarch64-apple-ios-sim

rustup target add aarch64-apple-darwin

Find script here

./scripts/ios/build-ios.sh

Find script here

./scripts/ios/test.sh

./scripts/ios/test.sh --summary

./scripts/ios/test.sh --testonly

If you change lcov format in export_code.cov.sh please use an updated file name.

./scripts/ios/test.sh --codecov swift_code_cov.lcov

Alternatively if you wanna skip code cove

brew install jenv

Dont forget to add to eval to zsh

export PATH="$HOME/.jenv/bin:$PATH"
eval "$(jenv init -)"

(or similar)

brew install openjdk@17

jenv add /opt/homebrew/Cellar/openjdk@17/17.0.10/libexec/openjdk.jdk/Contents/Home/

(or similar)

brew install ktlint

cargo install cargo-ndk

rustup target add aarch64-linux-android armv7-linux-androideabi

rustup target add aarch64-apple-darwin

Download the latest NDK from android studio

Then make sure that you have added these in your path

export ANDROID_HOME=<path-to-your-sdk>
export ANDROID_NDK_HOME=$ANDROID_HOME/ndk/<version>

# Make sure to also include the SDK ROOT in order to build the mac os desktop binaries
export SDKROOT="`xcrun --show-sdk-path`"

Then you can build both libraries as a usual

cd jvm

# For android library (Debug)
./gradlew sargon-android:assembleDebug
# For android library (Release)
./gradlew sargon-android:assembleRelease

# For desktop binaries
./gradlew sargon-desktop-bins:assemble

./jvm/gradlew -p jvm/sargon-android testDebugUnitTest

brew install gh

Create a Github Personal Access Token (PAT) labeled "Classic" and give it these permissions: write:packages admin:org -> read:org

For the first time, you must:

gh auth login

Do this:

? What account do you want to log into? GitHub.com
? What is your preferred protocol for Git operations on this host? SSH
? Upload your SSH public key to your GitHub account? Skip
? How would you like to authenticate GitHub CLI? Paste an authentication token
Tip: you can generate a Personal Access Token here https://github.com/settings/tokens
The minimum required scopes are 'repo', 'read:org'.
? Paste your authentication token: ****************************************

If successful you should see:

- gh config set -h github.com git_protocol ssh
✓ Configured git protocol
✓ Logged in as <YOUR_GH_USERNAME>

Find script here

./scripts/ios/release.sh

See .github/workflows/release.yml

Two modules are published in Github's maven.

• sargon-android

  (See .github/workflows/release-android.yml)

  Contains the generated UniFFi Kotlin code and the runtime sargon binaries, in different architectures. It also contains the JNA dependency.

  Import with:

  implementation("com.radixdlt.sargon:sargon-android:<version>")
  

• sargon-desktop-bins

  (See .github/workflows/release-desktop-bins.yml)

  Contains only the runtime sargon binaries, built for desktop. Used when running Unit tests.

  Import with:

  testRuntimeOnly("com.radixdlt.sargon:sargon-desktop-bins:<version>")
  

See iOS example app in examples/iOS

Import the /jvm directory in Android Studio and run the app configuration.