Skip to content

README.md

Latest commit

 

History

History
94 lines (68 loc) · 3.23 KB

README.md

File metadata and controls

94 lines (68 loc) · 3.23 KB

Holochain Service

A library containing the HolochainService.

This library can be used by other projects that wish to run a holochain conductor as an Android Foreground Service.

How to Use in an Android App

Add the Sonatype Maven Central Repository as a dependency source in your project's build.gradle.kts

repositories {
    maven {
        url = uri("https://repo1.maven.org/maven2")
    }
    
    // Additional respositories...
}

Add the library to your dependencies list in your project's build.gradle.kts

dependencies {
    ...
    implementation("org.holochain.androidserviceruntime:service:0.0.21")
}

On Android 13 (API 33) and above, your app must request POST_NOTIFICATIONS permission at runtime.

private fun requestNotificationPermission() {
    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
        ActivityCompat.requestPermissions(
            this.activity, // Use your own activity
            arrayOf(Manifest.permission.POST_NOTIFICATIONS),
            1 // Use your own request code
        )
    }
}

Development

Publish to local Maven repository

The library can be published to a local maven repository for use in development. All other kotlin projects in this android-service-runtime git repo will check for matching dependencies in the local Maven repository before checking Maven Central.

To publish the library to the local Maven repository, run:

pnpm run build:runtime-types-ffi && pnpm run build:client && pnpm run publish:local:client && pnpm run build:runtime-ffi && pnpm run build:service && pnpm run publish:local:service

Clear local Maven Repository

Clear the local Maven repository by deleting this library from it:

rm -rf ~/.m2/repository/org/holochain

Run Tests

To run the test suite:

pnpm run build:runtime-types-ffi && pnpm run publish:local:client && pnpm run build:runtime-ffi && pnpm run test:service

Publishing

Authorize Publishing to Maven Central

  1. Copy gradle.properties.example to gradle.properties
  2. Create Maven Central account at https://central.sonatype.com
    1. Generate a User Token
    2. Set mavenCentralUsername and mavenCentralPassword in gradle.properties to the displayed username and password
  3. Ensure your Maven Central account has permissions to the org.holochain namespace (you'll need to ask someone else who has permission).
  4. Create signing key
    1. Create a key with: gpg --gen-key
    2. Retrieve your Key Id in short format with: gpg --list-keys --keyid-format=short
    3. Publish your public key to keyserver with: gpg --keyserver keys.openpgp.org --send-keys <YOUR KEY ID>
  5. Export the signing private key to a file with: gpg --keyring secring.gpg --export-secret-keys > ~/.gnupg/secring.gpg
  6. Add signing key to gradle.properties
    1. Set signing.keyId to your public Key Id in in short format
    2. Set signing.password to the key password
    3. Set signing.secretKeyRingFile to the path to your exported private key file

Publish to Maven Central

  1. Update the version number in build.gradle.kts, under mavenPublishing > coordinates

  2. Run the gradle command to publish: ./gradlew publishAllPublicationsToMavenCentralRepository