diff --git a/README.md b/README.md index 6fda756f58..933495cc69 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ transfer an asset in a more realistic transfer scenario. | **Smart Contract** | **Description** | **Tutorial** | **Smart contract languages** | **Application languages** | | -----------|------------------------------|----------|---------|---------| | [Basic](asset-transfer-basic) | The Basic sample smart contract that allows you to create and transfer an asset by putting data on the ledger and retrieving it. This sample is recommended for new Fabric users. | [Writing your first application](https://hyperledger-fabric.readthedocs.io/en/latest/write_first_app.html) | Go, JavaScript, TypeScript, Java | Go, TypeScript, Java | -| [Ledger queries](asset-transfer-ledger-queries) | The ledger queries sample demonstrates range queries and transaction updates using range queries (applicable for both LevelDB and CouchDB state databases), and how to deploy an index with your chaincode to support JSON queries (applicable for CouchDB state database only). | [Using CouchDB](https://hyperledger-fabric.readthedocs.io/en/latest/couchdb_tutorial.html) | Go, JavaScript | Java, JavaScript | +| [Ledger queries](asset-transfer-ledger-queries) | The ledger queries sample demonstrates range queries and transaction updates using range queries (applicable for both LevelDB and CouchDB state databases), and how to deploy an index with your chaincode to support JSON queries (applicable for CouchDB state database only). | [Using CouchDB](https://hyperledger-fabric.readthedocs.io/en/latest/couchdb_tutorial.html) | Go, JavaScript, Java, TypeScript | Java, JavaScript | | [Private data](asset-transfer-private-data) | This sample demonstrates the use of private data collections, how to manage private data collections with the chaincode lifecycle, and how the private data hash can be used to verify private data on the ledger. It also demonstrates how to control asset updates and transfers using client-based ownership and access control. | [Using Private Data](https://hyperledger-fabric.readthedocs.io/en/latest/private_data_tutorial.html) | Go, TypeScript, Java | TypeScript | | [State-Based Endorsement](asset-transfer-sbe) | This sample demonstrates how to override the chaincode-level endorsement policy to set endorsement policies at the key-level (data/asset level). | [Using State-based endorsement](https://github.com/hyperledger/fabric-samples/tree/main/asset-transfer-sbe) | Java, TypeScript | JavaScript | | [Secured agreement](asset-transfer-secured-agreement) | Smart contract that uses implicit private data collections, state-based endorsement, and organization-based ownership and access control to keep data private and securely transfer an asset with the consent of both the current owner and buyer. | [Secured asset transfer](https://hyperledger-fabric.readthedocs.io/en/latest/secured_asset_transfer/secured_private_asset_transfer_tutorial.html) | Go | TypeScript | diff --git a/asset-transfer-ledger-queries/chaincode-java/.gitattributes b/asset-transfer-ledger-queries/chaincode-java/.gitattributes new file mode 100644 index 0000000000..00a51aff5e --- /dev/null +++ b/asset-transfer-ledger-queries/chaincode-java/.gitattributes @@ -0,0 +1,6 @@ +# +# https://help.github.com/articles/dealing-with-line-endings/ +# +# These are explicitly windows files and should use crlf +*.bat text eol=crlf + diff --git a/asset-transfer-ledger-queries/chaincode-java/.gitignore b/asset-transfer-ledger-queries/chaincode-java/.gitignore new file mode 100644 index 0000000000..9dee44f601 --- /dev/null +++ b/asset-transfer-ledger-queries/chaincode-java/.gitignore @@ -0,0 +1,4 @@ +.idea/ +.gradle/ +build/ +bin/ diff --git a/asset-transfer-ledger-queries/chaincode-java/Dockerfile b/asset-transfer-ledger-queries/chaincode-java/Dockerfile new file mode 100644 index 0000000000..9849aaf4e3 --- /dev/null +++ b/asset-transfer-ledger-queries/chaincode-java/Dockerfile @@ -0,0 +1,31 @@ +# the first stage +FROM gradle:9-jdk25 AS gradle_build + +# copy the build.gradle and src code to the container +COPY src/ src/ +COPY build.gradle ./ + +# Build and package our code +RUN gradle --no-daemon build shadowJar -x checkstyleMain -x checkstyleTest + + +# the second stage of our build just needs the compiled files +FROM eclipse-temurin:25-jre +ARG CC_SERVER_PORT=9999 + +# Setup tini to work better handle signals +ENV TINI_VERSION=v0.19.0 +ADD https://github.com/krallin/tini/releases/download/${TINI_VERSION}/tini /tini +RUN chmod +x /tini + +RUN addgroup --system javauser && useradd -g javauser javauser + +# copy only the artifacts we need from the first stage and discard the rest +COPY --chown=javauser:javauser --from=gradle_build /home/gradle/build/libs/chaincode.jar /chaincode.jar +COPY --chown=javauser:javauser docker/docker-entrypoint.sh /docker-entrypoint.sh + +ENV PORT=$CC_SERVER_PORT +EXPOSE $CC_SERVER_PORT + +USER javauser +ENTRYPOINT [ "/tini", "--", "/docker-entrypoint.sh" ] diff --git a/asset-transfer-ledger-queries/chaincode-java/build.gradle b/asset-transfer-ledger-queries/chaincode-java/build.gradle new file mode 100644 index 0000000000..c10d679f74 --- /dev/null +++ b/asset-transfer-ledger-queries/chaincode-java/build.gradle @@ -0,0 +1,91 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + */ + +plugins { + id 'com.gradleup.shadow' version '9.2.2' + id 'application' + id 'checkstyle' + id 'jacoco' +} + +group 'org.hyperledger.fabric.samples' +version '1.0-SNAPSHOT' + +dependencies { + implementation 'org.hyperledger.fabric-chaincode-java:fabric-chaincode-shim:2.5.+' + implementation 'org.json:json:+' + implementation 'com.owlike:genson:1.6' + testImplementation platform('org.junit:junit-bom:5.14.0') + testImplementation 'org.junit.jupiter:junit-jupiter' + testImplementation 'org.assertj:assertj-core:3.27.6' + testImplementation 'org.mockito:mockito-core:5.20.0' + testRuntimeOnly 'org.junit.platform:junit-platform-launcher' +} + +repositories { + mavenCentral() + maven { + url 'https://jitpack.io' + } +} + +compileJava { + options.release = 11 +} + +application { + mainClass = 'org.hyperledger.fabric.contract.ContractRouter' +} + +checkstyle { + toolVersion '8.21' + configFile file("config/checkstyle/checkstyle.xml") +} + +checkstyleMain { + source ='src/main/java' +} + +checkstyleTest { + source ='src/test/java' +} + +jacocoTestReport { + dependsOn test +} + +jacocoTestCoverageVerification { + violationRules { + rule { + limit { + minimum = 0.9 + } + } + } + + finalizedBy jacocoTestReport +} + +test { + useJUnitPlatform() + testLogging { + events "passed", "skipped", "failed" + } +} + +shadowJar { + archiveBaseName = 'chaincode' + archiveVersion = '' + archiveClassifier = '' + + duplicatesStrategy = DuplicatesStrategy.INCLUDE + mergeServiceFiles() + + manifest { + attributes 'Main-Class': 'org.hyperledger.fabric.contract.ContractRouter' + } +} + +check.dependsOn jacocoTestCoverageVerification +installDist.dependsOn check diff --git a/asset-transfer-ledger-queries/chaincode-java/gradle/wrapper/gradle-wrapper.jar b/asset-transfer-ledger-queries/chaincode-java/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000000..8bdaf60c75 Binary files /dev/null and b/asset-transfer-ledger-queries/chaincode-java/gradle/wrapper/gradle-wrapper.jar differ diff --git a/asset-transfer-ledger-queries/chaincode-java/gradle/wrapper/gradle-wrapper.properties b/asset-transfer-ledger-queries/chaincode-java/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000000..2e1113280e --- /dev/null +++ b/asset-transfer-ledger-queries/chaincode-java/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-9.1.0-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/asset-transfer-ledger-queries/chaincode-java/gradlew b/asset-transfer-ledger-queries/chaincode-java/gradlew new file mode 100644 index 0000000000..adff685a03 --- /dev/null +++ b/asset-transfer-ledger-queries/chaincode-java/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# Copyright © 2015 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. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# 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/HEAD/platforms/jvm/plugins-application/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 + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit + +# 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 + + + +# 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 + if ! command -v java >/dev/null 2>&1 + then + 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 +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + 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" ) + + 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 + + +# 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"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# 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/asset-transfer-ledger-queries/chaincode-java/gradlew.bat b/asset-transfer-ledger-queries/chaincode-java/gradlew.bat new file mode 100644 index 0000000000..c4bdd3ab8e --- /dev/null +++ b/asset-transfer-ledger-queries/chaincode-java/gradlew.bat @@ -0,0 +1,93 @@ +@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 +@rem SPDX-License-Identifier: Apache-2.0 +@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=. +@rem This is normally unused +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% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 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! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/asset-transfer-ledger-queries/chaincode-java/settings.gradle b/asset-transfer-ledger-queries/chaincode-java/settings.gradle new file mode 100644 index 0000000000..e281617397 --- /dev/null +++ b/asset-transfer-ledger-queries/chaincode-java/settings.gradle @@ -0,0 +1,4 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + */ +rootProject.name = 'ledger-queries' \ No newline at end of file diff --git a/asset-transfer-ledger-queries/chaincode-java/src/main/java/org/hyperledger/fabric/samples/assettransfer/Asset.java b/asset-transfer-ledger-queries/chaincode-java/src/main/java/org/hyperledger/fabric/samples/assettransfer/Asset.java new file mode 100644 index 0000000000..ff077ab9ce --- /dev/null +++ b/asset-transfer-ledger-queries/chaincode-java/src/main/java/org/hyperledger/fabric/samples/assettransfer/Asset.java @@ -0,0 +1,101 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + */ + +package org.hyperledger.fabric.samples.assettransfer; + +import java.util.Objects; + +import org.hyperledger.fabric.contract.annotation.DataType; +import org.hyperledger.fabric.contract.annotation.Property; + +import com.owlike.genson.annotation.JsonProperty; + +@DataType() +public final class Asset { + + @Property() + private final String docType; + + @Property() + private final String assetID; + + @Property() + private final String color; + + @Property() + private final int size; + + @Property() + private final String owner; + + @Property() + private final int appraisedValue; + + public String getDocType() { + return docType; + } + + public String getAssetID() { + return assetID; + } + + public String getColor() { + return color; + } + + public int getSize() { + return size; + } + + public String getOwner() { + return owner; + } + + public int getAppraisedValue() { + return appraisedValue; + } + + public Asset(@JsonProperty("docType") final String docType, @JsonProperty("assetID") final String assetID, + @JsonProperty("color") final String color, @JsonProperty("size") final int size, + @JsonProperty("owner") final String owner, @JsonProperty("appraisedValue") final int appraisedValue) { + this.docType = docType; + this.assetID = assetID; + this.color = color; + this.size = size; + this.owner = owner; + this.appraisedValue = appraisedValue; + } + + @Override + public boolean equals(final Object obj) { + if (this == obj) { + return true; + } + + if ((obj == null) || (getClass() != obj.getClass())) { + return false; + } + + Asset other = (Asset) obj; + + return Objects.deepEquals( + new String[] {getDocType(), getAssetID(), getColor(), getOwner()}, + new String[] {other.getDocType(), other.getAssetID(), other.getColor(), other.getOwner()}) + && + Objects.deepEquals( + new int[] {getSize(), getAppraisedValue()}, + new int[] {other.getSize(), other.getAppraisedValue()}); + } + + @Override + public int hashCode() { + return Objects.hash(getDocType(), getAssetID(), getColor(), getSize(), getOwner(), getAppraisedValue()); + } + + @Override + public String toString() { + return this.getClass().getSimpleName() + "@" + Integer.toHexString(hashCode()) + " [docType=" + docType + ", assetID=" + assetID + ", color=" + + color + ", size=" + size + ", owner=" + owner + ", appraisedValue=" + appraisedValue + "]"; + } +} diff --git a/asset-transfer-ledger-queries/chaincode-java/src/main/java/org/hyperledger/fabric/samples/assettransfer/AssetTransfer.java b/asset-transfer-ledger-queries/chaincode-java/src/main/java/org/hyperledger/fabric/samples/assettransfer/AssetTransfer.java new file mode 100644 index 0000000000..3189bb41c3 --- /dev/null +++ b/asset-transfer-ledger-queries/chaincode-java/src/main/java/org/hyperledger/fabric/samples/assettransfer/AssetTransfer.java @@ -0,0 +1,318 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + */ + +package org.hyperledger.fabric.samples.assettransfer; + +import java.util.ArrayList; +import java.util.List; + +import org.hyperledger.fabric.contract.Context; +import org.hyperledger.fabric.contract.ContractInterface; +import org.hyperledger.fabric.contract.annotation.Contact; +import org.hyperledger.fabric.contract.annotation.Contract; +import org.hyperledger.fabric.contract.annotation.Default; +import org.hyperledger.fabric.contract.annotation.Info; +import org.hyperledger.fabric.contract.annotation.License; +import org.hyperledger.fabric.contract.annotation.Transaction; +import org.hyperledger.fabric.shim.ChaincodeException; +import org.hyperledger.fabric.shim.ChaincodeStub; +import org.hyperledger.fabric.shim.ledger.KeyModification; +import org.hyperledger.fabric.shim.ledger.KeyValue; +import org.hyperledger.fabric.shim.ledger.QueryResultsIterator; +import org.hyperledger.fabric.shim.ledger.QueryResultsIteratorWithMetadata; + +import com.owlike.genson.Genson; + +@Contract( + name = "ledger-queries", + info = @Info( + title = "Asset Transfer Ledger Queries", + description = "The Asset Transfer Ledger Queries sample chaincode", + version = "1.0.0", + license = @License( + name = "Apache 2.0 License", + url = "http://www.apache.org/licenses/LICENSE-2.0.html"), + contact = @Contact( + email = "a.transfer@example.com", + name = "Adrian Transfer", + url = "https://hyperledger.example.com"))) +@Default +public final class AssetTransfer implements ContractInterface { + + private final Genson genson = new Genson(); + + private enum AssetTransferErrors { + ASSET_NOT_FOUND, + ASSET_ALREADY_EXISTS + } + + /** + * Creates some initial assets on the ledger. + * + * @param ctx the transaction context + */ + @Transaction(intent = Transaction.TYPE.SUBMIT) + public void InitLedger(final Context ctx) { + putAsset(ctx, new Asset("asset", "asset1", "blue", 5, "Tomoko", 300)); + putAsset(ctx, new Asset("asset", "asset2", "red", 5, "Brad", 400)); + putAsset(ctx, new Asset("asset", "asset3", "green", 10, "Jin Soo", 500)); + putAsset(ctx, new Asset("asset", "asset4", "yellow", 10, "Max", 600)); + putAsset(ctx, new Asset("asset", "asset5", "black", 15, "Adrian", 700)); + putAsset(ctx, new Asset("asset", "asset6", "white", 15, "Michel", 700)); + + } + + /** + * Creates a new asset on the ledger. + * + * @param ctx the transaction context + * @param assetID the ID of the new asset + * @param color the color of the new asset + * @param size the size for the new asset + * @param owner the owner of the new asset + * @param appraisedValue the appraisedValue of the new asset + * @return the created asset + */ + @Transaction(intent = Transaction.TYPE.SUBMIT) + public Asset CreateAsset(final Context ctx, final String assetID, final String color, final int size, + final String owner, final int appraisedValue) { + + if (AssetExists(ctx, assetID)) { + String errorMessage = String.format("Asset %s already exists", assetID); + System.out.println(errorMessage); + throw new ChaincodeException(errorMessage, AssetTransferErrors.ASSET_ALREADY_EXISTS.toString()); + } + + return putAsset(ctx, new Asset("asset", assetID, color, size, owner, appraisedValue)); + } + + private Asset putAsset(final Context ctx, final Asset asset) { + String sortedJson = genson.serialize(asset); + ctx.getStub().putStringState(asset.getAssetID(), sortedJson); + + // Create composite key for color~name index + String indexKey = ctx.getStub().createCompositeKey("color~name", asset.getColor(), asset.getAssetID()).toString(); + ctx.getStub().putState(indexKey, new byte[] {0x00}); + + return asset; + } + + /** + * Retrieves an asset with the specified ID from the ledger. + * + * @param ctx the transaction context + * @param assetID the ID of the asset + * @return the asset found on the ledger if there was one + */ + @Transaction(intent = Transaction.TYPE.EVALUATE) + public Asset ReadAsset(final Context ctx, final String assetID) { + String assetJSON = ctx.getStub().getStringState(assetID); + + if (assetJSON == null || assetJSON.isEmpty()) { + String errorMessage = String.format("Asset %s does not exist", assetID); + System.out.println(errorMessage); + throw new ChaincodeException(errorMessage, AssetTransferErrors.ASSET_NOT_FOUND.toString()); + } + + return genson.deserialize(assetJSON, Asset.class); + } + + /** + * Updates the properties of an asset on the ledger. + * + * @param ctx the transaction context + * @param assetID the ID of the asset being updated + * @param color the color of the asset being updated + * @param size the size of the asset being updated + * @param owner the owner of the asset being updated + * @param appraisedValue the appraisedValue of the asset being updated + * @return the transferred asset + */ + @Transaction(intent = Transaction.TYPE.SUBMIT) + public Asset UpdateAsset(final Context ctx, final String assetID, final String color, final int size, + final String owner, final int appraisedValue) { + + Asset asset = ReadAsset(ctx, assetID); + + // Delete old index if color changed + if (!asset.getColor().equals(color)) { + String oldIndexKey = ctx.getStub().createCompositeKey("color~name", asset.getColor(), asset.getAssetID()).toString(); + ctx.getStub().delState(oldIndexKey); + } + + Asset updatedAsset = new Asset("asset", assetID, color, size, owner, appraisedValue); + return putAsset(ctx, updatedAsset); + } + + /** + * Deletes asset on the ledger. + * + * @param ctx the transaction context + * @param assetID the ID of the asset being deleted + */ + @Transaction(intent = Transaction.TYPE.SUBMIT) + public void DeleteAsset(final Context ctx, final String assetID) { + Asset asset = ReadAsset(ctx, assetID); + + ctx.getStub().delState(assetID); + + // Delete composite key index + String indexKey = ctx.getStub().createCompositeKey("color~name", asset.getColor(), asset.getAssetID()).toString(); + ctx.getStub().delState(indexKey); + } + + /** + * Checks the existence of the asset on the ledger + * + * @param ctx the transaction context + * @param assetID the ID of the asset + * @return boolean indicating the existence of the asset + */ + @Transaction(intent = Transaction.TYPE.EVALUATE) + public boolean AssetExists(final Context ctx, final String assetID) { + String assetJSON = ctx.getStub().getStringState(assetID); + + return (assetJSON != null && !assetJSON.isEmpty()); + } + + /** + * Changes the owner of a asset on the ledger. + * + * @param ctx the transaction context + * @param assetID the ID of the asset being transferred + * @param newOwner the new owner + * @return the old owner + */ + @Transaction(intent = Transaction.TYPE.SUBMIT) + public String TransferAsset(final Context ctx, final String assetID, final String newOwner) { + Asset asset = ReadAsset(ctx, assetID); + String oldOwner = asset.getOwner(); + + Asset updatedAsset = new Asset(asset.getDocType(), asset.getAssetID(), asset.getColor(), asset.getSize(), newOwner, asset.getAppraisedValue()); + putAsset(ctx, updatedAsset); + + return oldOwner; + } + + /** + * GetAssetsByRange performs a range query based on the start and end keys provided. + */ + @Transaction(intent = Transaction.TYPE.EVALUATE) + public String GetAssetsByRange(final Context ctx, final String startKey, final String endKey) { + QueryResultsIterator results = ctx.getStub().getStateByRange(startKey, endKey); + List queryResults = new ArrayList<>(); + + for (KeyValue res : results) { + Asset asset = genson.deserialize(res.getStringValue(), Asset.class); + queryResults.add(asset); + } + + return genson.serialize(queryResults); + } + + /** + * TransferAssetByColor will transfer assets of a given color to a certain new owner. + * This method demonstrates the use of composite keys for range queries. + */ + @Transaction(intent = Transaction.TYPE.SUBMIT) + public void TransferAssetByColor(final Context ctx, final String color, final String newOwner) { + QueryResultsIterator results = ctx.getStub().getStateByPartialCompositeKey("color~name", color); + + for (KeyValue res : results) { + String compositeKey = res.getKey(); + String[] keyParts = ctx.getStub().splitCompositeKey(compositeKey).getAttributes().toArray(new String[0]); + + if (keyParts.length > 0) { + String assetID = keyParts[0]; // The second part of the composite key is the ID + TransferAsset(ctx, assetID, newOwner); + } + } + } + + /** + * GetQueryResultForQueryString executes the passed in query string. + * Result set is built and returned as a list of assets. + */ + private String getQueryResultForQueryString(final ChaincodeStub stub, final String queryString) { + QueryResultsIterator results = stub.getQueryResult(queryString); + List queryResults = new ArrayList<>(); + + for (KeyValue res: results) { + Asset asset = genson.deserialize(res.getStringValue(), Asset.class); + queryResults.add(asset); + } + + return genson.serialize(queryResults); + } + + /** + * QueryAssetsByOwner queries for assets based on the passed in owner. + * This is an example of a parameterized query where the query logic is baked into the chaincode, + * and accepting a single query parameter (owner). + * Only available on state databases that support rich query (e.g. CouchDB) + */ + @Transaction(intent = Transaction.TYPE.EVALUATE) + public String QueryAssetsByOwner(final Context ctx, final String owner) { + String queryString = String.format("{\"selector\":{\"docType\":\"asset\",\"owner\":\"%s\"}}", owner); + return getQueryResultForQueryString(ctx.getStub(), queryString); + } + + /** + * QueryAssets queries for assets based on a passed in query string. + * This is an example of a rich query where the query string is passed in by the caller. + * Only available on state databases that support rich query (e.g. CouchDB) + */ + @Transaction(intent = Transaction.TYPE.EVALUATE) + public String QueryAssets(final Context ctx, final String queryString) { + return getQueryResultForQueryString(ctx.getStub(), queryString); + } + + /** + * GetAssetHistory returns the chain of custody for an asset since issuance. + */ + @Transaction(intent = Transaction.TYPE.EVALUATE) + public String GetAssetHistory(final Context ctx, final String assetID) { + QueryResultsIterator results = ctx.getStub().getHistoryForKey(assetID); + List history = new ArrayList<>(); + + for (KeyModification res: results) { + history.add(res); + } + + return genson.serialize(history); + } + + /** + * QueryAssetsWithPagination executes a "rich" query, and returns a page of results. + */ + @Transaction(intent = Transaction.TYPE.EVALUATE) + public String QueryAssetsWithPagination(final Context ctx, final String queryString, final int pageSize, final String bookmark) { + QueryResultsIteratorWithMetadata results = ctx.getStub().getQueryResultWithPagination(queryString, pageSize, bookmark); + + List queryResults = new ArrayList<>(); + for (KeyValue res: results) { + Asset asset = genson.deserialize(res.getStringValue(), Asset.class); + queryResults.add(asset); + } + + return genson.serialize(queryResults); + } + + /** + * GetAssetsByRangeWithPagination performs a range query based on the start and end key, + * page size and a bookmark. + */ + @Transaction(intent = Transaction.TYPE.EVALUATE) + public String GetAssetsByRangeWithPagination(final Context ctx, final String startKey, final String endKey, final int pageSize, final String bookmark) { + QueryResultsIteratorWithMetadata results = ctx.getStub().getStateByRangeWithPagination(startKey, endKey, pageSize, bookmark); + + List queryResults = new ArrayList<>(); + for (KeyValue res: results) { + Asset asset = genson.deserialize(res.getStringValue(), Asset.class); + queryResults.add(asset); + } + + return genson.serialize(queryResults); + } +} diff --git a/asset-transfer-ledger-queries/chaincode-java/src/main/resources/META-INF/statedb/couchdb/indexes/indexOwner.json b/asset-transfer-ledger-queries/chaincode-java/src/main/resources/META-INF/statedb/couchdb/indexes/indexOwner.json new file mode 100644 index 0000000000..305f090444 --- /dev/null +++ b/asset-transfer-ledger-queries/chaincode-java/src/main/resources/META-INF/statedb/couchdb/indexes/indexOwner.json @@ -0,0 +1 @@ +{"index":{"fields":["docType","owner"]},"ddoc":"indexOwnerDoc", "name":"indexOwner","type":"json"} diff --git a/asset-transfer-private-data/chaincode-java/META-INF/statedb/couchdb/collections/assetCollection/indexes/indexOwner.json b/asset-transfer-private-data/chaincode-java/src/main/resources/META-INF/statedb/couchdb/collections/assetCollection/indexes/indexOwner.json similarity index 100% rename from asset-transfer-private-data/chaincode-java/META-INF/statedb/couchdb/collections/assetCollection/indexes/indexOwner.json rename to asset-transfer-private-data/chaincode-java/src/main/resources/META-INF/statedb/couchdb/collections/assetCollection/indexes/indexOwner.json diff --git a/test-network/scripts/packageCC.sh b/test-network/scripts/packageCC.sh index e457164d2f..bc9c9d4b0f 100755 --- a/test-network/scripts/packageCC.sh +++ b/test-network/scripts/packageCC.sh @@ -51,8 +51,18 @@ elif [ "$CC_SRC_LANGUAGE" = "java" ]; then infoln "Compiling Java code..." pushd $CC_SRC_PATH ./gradlew installDist + res=$? popd + verifyResult $res "Java compilation failed" successln "Finished compiling Java code" + + # Copy META-INF to the distribution directory if it exists + if [ -d "$CC_SRC_PATH/src/main/resources/META-INF" ]; then + cp -r "$CC_SRC_PATH/src/main/resources/META-INF" "$CC_SRC_PATH/build/install/$CC_NAME/" + elif [ -d "$CC_SRC_PATH/META-INF" ]; then + cp -r "$CC_SRC_PATH/META-INF" "$CC_SRC_PATH/build/install/$CC_NAME/" + fi + CC_SRC_PATH=$CC_SRC_PATH/build/install/$CC_NAME elif [ "$CC_SRC_LANGUAGE" = "javascript" ]; then @@ -65,7 +75,9 @@ elif [ "$CC_SRC_LANGUAGE" = "typescript" ]; then pushd $CC_SRC_PATH npm install npm run build + res=$? popd + verifyResult $res "TypeScript compilation failed" successln "Finished compiling TypeScript code into JavaScript" else @@ -90,7 +102,11 @@ packageChaincode() { res=$? { set +x; } 2>/dev/null cat log.txt - PACKAGE_ID=$(peer lifecycle chaincode calculatepackageid ${CC_NAME}.tar.gz) + if [ ${CC_PACKAGE_ONLY} = true ] ; then + PACKAGE_ID=$(peer lifecycle chaincode calculatepackageid packagedChaincode/${CC_NAME}_${CC_VERSION}.tar.gz) + else + PACKAGE_ID=$(peer lifecycle chaincode calculatepackageid ${CC_NAME}.tar.gz) + fi verifyResult $res "Chaincode packaging has failed" successln "Chaincode is packaged" }