Migrating SDK examples repo into multi-module project structure

.github/workflows/ci-examples-pull-request.yml

@@ -0,0 +1,69 @@
+name: Build SDK Examples Pull Request
+on: pull_request
+
+jobs:
+  build:
+    name: Build pull request
+    runs-on: ubuntu-latest
+    env:
+      JAVA_OPTS: -Xmx2g -Dorg.gradle.daemon=false
+    #services:
+    #  flow-emulator:
+    #    image: gcr.io/flow-container-registry/emulator
+    #    env:
+    #      FLOW_VERBOSE: true
+    #      FLOW_PORT: 3569
+    #      FLOW_INTERVAL: 5s
+    #      FLOW_PERSIST: false
+    #    ports:
+    #      - 3569:3569
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup Java
+        uses: actions/setup-java@v2
+        with:
+          java-version: '21'
+          java-package: jdk
+          distribution: 'adopt'
+
+      - name: Install flow emulator
+        run: sh -ci "$(curl -fsSL https://storage.googleapis.com/flow-cli/install.sh)"
+
+      - name: Make gradle executable
+        run: chmod +x ./gradlew
+
+      - name: Build
+        id: build
+        run: ./gradlew --warning-mode all check build -x test -x integrationTest
+
+      - name: Start emulator
+        id: start_emulator
+        if: ${{ steps.build.outcome == 'success' }}
+        run: |
+          nohup flow emulator start -v --persist > flow-emulator.log 2>&1 &
+
+      - name: Wait for emulator to start
+        id: wait_for_emulator
+        if: ${{ steps.start_emulator.outcome == 'success' }}
+        run: sleep 15
+
+      - name: Run Java Example Unit Tests
+        id: unit_test
+        if: ${{ steps.wait_for_emulator.outcome == 'success' }}
+        run: ./gradlew --no-daemon --max-workers=2 --warning-mode=all :java-example:test -i --continue --stacktrace
+
+      - name: Run Kotlin Example Unit Tests
+        id: unit_test_2
+        if: ${{ steps.wait_for_emulator.outcome == 'success' }}
+        run: ./gradlew --no-daemon --max-workers=2 --warning-mode=all :kotlin-example:test -i --continue --stacktrace
+
+      - name: Publish SDK Examples Unit Test Results
+        uses: EnricoMi/[email protected]
+        if: always()
+        with:
+          check_name: "SDK Examples Unit Test Results"
+          files: "**/test-results/test/**/*.xml"
+          seconds_between_github_writes: 5
+          secondary_rate_limit_wait_seconds: 120

.github/workflows/ci-manual-publish-release.yml → .github/workflows/ci-sdk-manual-publish-release.yml

@@ -38,7 +38,7 @@ jobs:
         run: sh -ci "$(curl -fsSL https://storage.googleapis.com/flow-cli/install.sh)"
 
       - name: Make gradle executable
-        run: chmod +x ./gradlew
+        run: chmod +x ./sdk/gradlew
 
       - name: Build
         id: build
@@ -60,4 +60,4 @@ jobs:
           ./gradlew \
             -Psigning.key="${{ secrets.FLOW_JVM_SDK_SIGNING_KEY }}" \
             -Psigning.password="${{ secrets.FLOW_JVM_SDK_SIGNING_PASSWORD }}" \
-            publishAndReleaseToMavenCentral --no-configuration-cache
+            :sdk:publishAndReleaseToMavenCentral --no-configuration-cache

.github/workflows/ci-manual-publish-snapshot.yml → .github/workflows/ci-sdk-manual-publish-snapshot.yml

@@ -38,7 +38,7 @@ jobs:
         run: sh -ci "$(curl -fsSL https://storage.googleapis.com/flow-cli/install.sh)"
 
       - name: Make gradle executable
-        run: chmod +x ./gradlew
+        run: chmod +x ./sdk/gradlew
 
       - name: Build
         id: build
@@ -60,4 +60,4 @@ jobs:
           ./gradlew \
             -Psigning.key="${{ secrets.FLOW_JVM_SDK_SIGNING_KEY }}" \
             -Psigning.password="${{ secrets.FLOW_JVM_SDK_SIGNING_PASSWORD }}" \
-            publishToMavenCentral --no-configuration-cache
+            :sdk:publishToMavenCentral --no-configuration-cache

.github/workflows/ci-publish-release.yml → .github/workflows/ci-sdk-publish-release.yml

@@ -37,7 +37,7 @@ jobs:
         run: sh -ci "$(curl -fsSL https://storage.googleapis.com/flow-cli/install.sh)"
 
       - name: Make gradle executable
-        run: chmod +x ./gradlew
+        run: chmod +x ./sdk/gradlew
 
       - name: Build
         id: build
@@ -48,7 +48,7 @@ jobs:
         if: ${{ steps.build.outcome == 'success' }}
         run: |
           export PATH="$HOME/.local/bin:$PATH"
-          ./gradlew --no-daemon --max-workers=2 --warning-mode=all test --continue --stacktrace
+          ./gradlew --no-daemon --max-workers=2 --warning-mode=all :sdk:test --continue --stacktrace
 
       - name: Publish Unit Test Results
         uses: EnricoMi/[email protected]
@@ -63,7 +63,7 @@ jobs:
         if: ${{ steps.unit_test.outcome == 'success' }}
         run: |
           export PATH="$HOME/.local/bin:$PATH"
-          ./gradlew --no-daemon --max-workers=2 --warning-mode=all integrationTest --continue --stacktrace
+          ./gradlew --no-daemon --max-workers=2 --warning-mode=all :sdk:integrationTest --continue --stacktrace
 
       - name: Publish Integration Test Results
         uses: EnricoMi/[email protected]
@@ -90,5 +90,5 @@ jobs:
           ./gradlew \
             -Psigning.key="${{ secrets.FLOW_JVM_SDK_SIGNING_KEY }}" \
             -Psigning.password="${{ secrets.FLOW_JVM_SDK_SIGNING_PASSWORD }}" \
-            publishAndReleaseToMavenCentral --no-configuration-cache
+            :sdk:publishAndReleaseToMavenCentral --no-configuration-cache
 

.github/workflows/ci-publish-snapshot.yml → .github/workflows/ci-sdk-publish-snapshot.yml

@@ -38,7 +38,7 @@ jobs:
         run: sh -ci "$(curl -fsSL https://storage.googleapis.com/flow-cli/install.sh)"
 
       - name: Make gradle executable
-        run: chmod +x ./gradlew
+        run: chmod +x ./sdk/gradlew
 
       - name: Build
         id: build
@@ -49,7 +49,7 @@ jobs:
         if: ${{ steps.build.outcome == 'success' }}
         run: |
           export PATH="$HOME/.local/bin:$PATH"
-          ./gradlew --no-daemon --max-workers=2 --warning-mode=all test --continue --stacktrace
+          ./gradlew --no-daemon --max-workers=2 --warning-mode=all :sdk:test --continue --stacktrace
 
       - name: Publish Unit Test Results
         uses: EnricoMi/[email protected]
@@ -64,7 +64,7 @@ jobs:
         if: ${{ steps.unit_test.outcome == 'success' }}
         run: |
           export PATH="$HOME/.local/bin:$PATH"
-          ./gradlew --no-daemon --max-workers=2 --warning-mode=all integrationTest --continue --stacktrace
+          ./gradlew --no-daemon --max-workers=2 --warning-mode=all :sdk:integrationTest --continue --stacktrace
 
       - name: Publish Integration Test Results
         uses: EnricoMi/[email protected]
@@ -91,4 +91,4 @@ jobs:
           ./gradlew \
             -Psigning.key="${{ secrets.FLOW_JVM_SDK_SIGNING_KEY }}" \
             -Psigning.password="${{ secrets.FLOW_JVM_SDK_SIGNING_PASSWORD }}" \
-            publishToMavenCentral --no-configuration-cache
+            :sdk:publishToMavenCentral --no-configuration-cache

.github/workflows/ci-pull-request.yml → .github/workflows/ci-sdk-pull-request.yml

@@ -1,4 +1,4 @@
-name: Build Pull Request
+name: Build SDK Pull Request
 on: pull_request
 
 jobs:
@@ -43,7 +43,7 @@ jobs:
         if: ${{ steps.build.outcome == 'success' }}
         run: |
           export PATH="$HOME/.local/bin:$PATH"
-          ./gradlew --no-daemon --max-workers=2 --warning-mode=all test --continue --stacktrace
+          ./gradlew --no-daemon --max-workers=2 --warning-mode=all :sdk:test --continue --stacktrace
 
       - name: Publish Unit Test Results
         uses: EnricoMi/[email protected]
@@ -58,7 +58,7 @@ jobs:
         if: ${{ steps.unit_test.outcome == 'success' }}
         run: |
           export PATH="$HOME/.local/bin:$PATH"
-          ./gradlew --no-daemon --max-workers=2 --warning-mode=all integrationTest --continue --stacktrace
+          ./gradlew --no-daemon --max-workers=2 --warning-mode=all :sdk:integrationTest --continue --stacktrace
 
       - name: Publish Integration Test Results
         uses: EnricoMi/[email protected]

.gitignore

@@ -1,4 +1,5 @@
 build
 .gradle
 .idea
-gradle.properties
+sdk/gradle.properties
+flowdb

README.md

@@ -13,162 +13,18 @@ At the moment, this SDK includes the following features:
 - [x] Marshalling & unmarshalling of [JSON-Cadence](https://docs.onflow.org/cadence/json-cadence-spec/)
 - [x] DSL for creating, signing, and sending transactions and scripts
 
-## Installation
+## Repository modules
 
-Use the configuration below to add this 
-SDK to your project using Maven or Gradle.
+This repository is organized as a multi-module project, consisting of the following modules:
 
-### Maven
+### SDK
+The core module that includes all the necessary tools and libraries to interact with the Flow blockchain. This module provides the main functionalities such as transaction preparation, signing, and interaction with the Flow Access API.
 
-```xml
-<!--
-    the following repository is required because the trusted data framework
-    is not available on maven central.
- -->
-<repositories>
-  <repository>
-    <id>jitpack.io</id>
-    <url>https://jitpack.io</url>
-  </repository>
-</repositories>
+### Java Example
+This module contains example implementations demonstrating how to use the Flow JVM SDK in a Java application. It includes sample code for various use cases, making it easier for developers to understand and integrate the SDK into their Java projects.
 
-<dependency>
-  <groupId>org.onflow</groupId>
-  <artifactId>flow-jvm-sdk</artifactId>
-  <version>[VERSION HERE]</version>
-</dependency>
-```
-
-### Gradle
-
-```groovy
-repositories {
-    ...
-    /*
-        the following repository is required because the trusted data framework
-        is not available on maven central.
-    */
-    maven { url 'https://jitpack.io' }
-}
-
-dependencies {
-    api("org.onflow:flow-jvm-sdk:[VERSION HERE]")
-}
-```
-
-### Gradle (with test extensions)
-
-```groovy
-plugins {
-    ...
-    id("java-test-fixtures")
-}
-
-repositories {
-    ...
-    /*
-        the following repository is required because the trusted data framework
-        is not available on maven central.
-    */
-    maven { url 'https://jitpack.io' }
-}
-
-dependencies {
-    api("org.onflow:flow-jvm-sdk:[VERSION HERE]")
-    testFixturesApi(testFixtures("org.onflow:flow-jvm-sdk:[VERSION HERE]"))
-}
-```
-
-The jitpack.io repository is necessary to access some of the dependencies of this library that are not available on Maven Central.
-
-## Example usage
-
-Check out the [example repository](https://github.com/onflow/flow-java-client-example) for an example
-of how to use this SDK in a Java application.
-
-## Integration tests
-
-Tests annotated with `FlowEmulatorTest` depend on the [Flow Emulator](https://github.com/onflow/flow-emulator), which is part of the [Flow CLI](https://github.com/onflow/flow-cli) to be installed on your machine.
-
-The`FlowEmulatorTest` extension may be used by consumers of this library as well to streamline unit tests that interact
-with the FLOW blockchian. The `FlowEmulatorTest` extension uses the local flow emulator to prepare the test environment
-for unit and integration tests. For example:
-
-Setup dependency on the SDK:
-```gradle
-plugins {
-    id("java-test-fixtures")
-}
-
-repositories {
-    /*
-        the following repository is required because the trusted data framework
-        is not available on maven central.
-    */
-    maven { url 'https://jitpack.io' }
-}
-
-dependencies {
-    api("org.onflow:flow-jvm-sdk:[VERSION HERE]")
-
-    // this allows for using the test extension
-    testFixturesApi(testFixtures("org.onflow:flow-jvm-sdk:[VERSION HERE]"))
-}
-```
-
-Write your blockchain tests:
-```kotlin
-@FlowEmulatorTest
-class TransactionTest {
-
-    @FlowTestClient
-    lateinit var accessAPI: FlowAccessApi
-
-    @FlowServiceAccountCredentials
-    lateinit var serviceAccount: TestAccount
-
-    @Test
-    fun `Test something on the emnulator`() {
-        val result = accessAPI.simpleFlowTransaction(
-            serviceAccount.flowAddress,
-            serviceAccount.signer
-        ) {
-            script {
-                """
-                    transaction(publicKey: String) {
-                        prepare(signer: AuthAccount) {
-                            let account = AuthAccount(payer: signer)
-                            account.addPublicKey(publicKey.decodeHex())
-                        }
-                    }
-                """
-            }
-            arguments {
-                arg { string(newAccountPublicKey.encoded.bytesToHex()) }
-            }
-        }.sendAndWaitForSeal()
-            .throwOnError()
-        assertThat(result.status).isEqualTo(FlowTransactionStatus.SEALED)
-    }
-
-}
-```
-
-There are two ways to test using the emulator:
-
-- `@FlowEmulatorProjectTest` - this uses a `flow.json` file that has your configuration in it
-- `@FlowEmulatorTest` - this creates a fresh and temporary flow configuration for each test
-
-Also, the following annotations are available in tests as helpers:
-
-- `@FlowTestClient` - used to inject a `FlowAccessApi` or `AsyncFlowAccessApi` into your tests
-- `@FlowServiceAccountCredentials` - used to inject a `TestAccount` instance into your tests that contain
-  the flow service account credentials
-- `@FlowTestAccount` - used to automatically create an account in the emulator and inject a `TestAccount` instance
-  containing the new account's credentials.
-
-See [ProjectTestExtensionsTest](src/test/kotlin/com/nftco/flow/sdk/ProjectTestExtensionsTest.kt) and
-[TestExtensionsTest](src/test/kotlin/com/nftco/flow/sdk/TestExtensionsTest.kt) for examples.
+### Kotlin Example
+Similar to the Java Example module, this module provides sample implementations in Kotlin. It showcases how to leverage the SDK's capabilities in a Kotlin environment.
 
 ## Contribute to this SDK