org.hyperledger.fabric.shim.impl.ChaincodeMessageFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fabric-chaincode-shim Show documentation
Hyperledger Fabric Java Chaincode Shim
The newest version!
/*
 * Copyright 2019 IBM DTCC All Rights Reserved.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
package org.hyperledger.fabric.shim.impl;

import static org.hyperledger.fabric.protos.peer.ChaincodeMessage.Type.COMPLETED;
import static org.hyperledger.fabric.protos.peer.ChaincodeMessage.Type.DEL_STATE;
import static org.hyperledger.fabric.protos.peer.ChaincodeMessage.Type.ERROR;
import static org.hyperledger.fabric.protos.peer.ChaincodeMessage.Type.GET_PRIVATE_DATA_HASH;
import static org.hyperledger.fabric.protos.peer.ChaincodeMessage.Type.GET_STATE;
import static org.hyperledger.fabric.protos.peer.ChaincodeMessage.Type.GET_STATE_METADATA;
import static org.hyperledger.fabric.protos.peer.ChaincodeMessage.Type.INVOKE_CHAINCODE;
import static org.hyperledger.fabric.protos.peer.ChaincodeMessage.Type.PUT_STATE;
import static org.hyperledger.fabric.protos.peer.ChaincodeMessage.Type.PUT_STATE_METADATA;
import static org.hyperledger.fabric.protos.peer.ChaincodeMessage.Type.REGISTER;

import com.google.protobuf.ByteString;
import java.io.PrintWriter;
import java.io.StringWriter;
import org.hyperledger.fabric.protos.peer.ChaincodeEvent;
import org.hyperledger.fabric.protos.peer.ChaincodeID;
import org.hyperledger.fabric.protos.peer.ChaincodeMessage;
import org.hyperledger.fabric.protos.peer.ChaincodeMessage.Type;
import org.hyperledger.fabric.protos.peer.DelState;
import org.hyperledger.fabric.protos.peer.GetState;
import org.hyperledger.fabric.protos.peer.GetStateMetadata;
import org.hyperledger.fabric.protos.peer.PutState;
import org.hyperledger.fabric.protos.peer.PutStateMetadata;
import org.hyperledger.fabric.protos.peer.Response;
import org.hyperledger.fabric.protos.peer.Response.Builder;
import org.hyperledger.fabric.protos.peer.StateMetadata;
import org.hyperledger.fabric.shim.Chaincode;

public final class ChaincodeMessageFactory {

    private ChaincodeMessageFactory() {}

    static ChaincodeMessage newGetPrivateDataHashEventMessage(
            final String channelId, final String txId, final String collection, final String key) {
        return newEventMessage(
                GET_PRIVATE_DATA_HASH,
                channelId,
                txId,
                GetState.newBuilder()
                        .setCollection(collection)
                        .setKey(key)
                        .build()
                        .toByteString());
    }

    static ChaincodeMessage newGetStateEventMessage(
            final String channelId, final String txId, final String collection, final String key) {
        return newEventMessage(
                GET_STATE,
                channelId,
                txId,
                GetState.newBuilder()
                        .setCollection(collection)
                        .setKey(key)
                        .build()
                        .toByteString());
    }

    static ChaincodeMessage newGetStateMetadataEventMessage(
            final String channelId, final String txId, final String collection, final String key) {
        return newEventMessage(
                GET_STATE_METADATA,
                channelId,
                txId,
                GetStateMetadata.newBuilder()
                        .setCollection(collection)
                        .setKey(key)
                        .build()
                        .toByteString());
    }

    static ChaincodeMessage newPutStateEventMessage(
            final String channelId,
            final String txId,
            final String collection,
            final String key,
            final ByteString value) {
        return newEventMessage(
                PUT_STATE,
                channelId,
                txId,
                PutState.newBuilder()
                        .setCollection(collection)
                        .setKey(key)
                        .setValue(value)
                        .build()
                        .toByteString());
    }

    static ChaincodeMessage newPutStateMetadataEventMessage(
            final String channelId,
            final String txId,
            final String collection,
            final String key,
            final String metakey,
            final ByteString value) {
        return newEventMessage(
                PUT_STATE_METADATA,
                channelId,
                txId,
                PutStateMetadata.newBuilder()
                        .setCollection(collection)
                        .setKey(key)
                        .setMetadata(StateMetadata.newBuilder()
                                .setMetakey(metakey)
                                .setValue(value)
                                .build())
                        .build()
                        .toByteString());
    }

    static ChaincodeMessage newDeleteStateEventMessage(
            final String channelId, final String txId, final String collection, final String key) {
        return newEventMessage(
                DEL_STATE,
                channelId,
                txId,
                DelState.newBuilder()
                        .setCollection(collection)
                        .setKey(key)
                        .build()
                        .toByteString());
    }

    static ChaincodeMessage newPurgeStateEventMessage(
            final String channelId, final String txId, final String collection, final String key) {
        return newEventMessage(
                Type.PURGE_PRIVATE_DATA,
                channelId,
                txId,
                DelState.newBuilder()
                        .setCollection(collection)
                        .setKey(key)
                        .build()
                        .toByteString());
    }

    static ChaincodeMessage newErrorEventMessage(final String channelId, final String txId, final Throwable throwable) {
        return newErrorEventMessage(channelId, txId, printStackTrace(throwable));
    }

    static ChaincodeMessage newErrorEventMessage(final String channelId, final String txId, final String message) {
        return newErrorEventMessage(channelId, txId, message, null);
    }

    static ChaincodeMessage newErrorEventMessage(
            final String channelId, final String txId, final String message, final ChaincodeEvent event) {
        return newEventMessage(ERROR, channelId, txId, ByteString.copyFromUtf8(message), event);
    }

    static ChaincodeMessage newCompletedEventMessage(
            final String channelId, final String txId, final Chaincode.Response response, final ChaincodeEvent event) {
        return newEventMessage(
                COMPLETED, channelId, txId, toProtoResponse(response).toByteString(), event);
    }

    static ChaincodeMessage newInvokeChaincodeMessage(
            final String channelId, final String txId, final ByteString payload) {
        return newEventMessage(INVOKE_CHAINCODE, channelId, txId, payload, null);
    }

    static ChaincodeMessage newRegisterChaincodeMessage(final ChaincodeID chaincodeId) {
        return ChaincodeMessage.newBuilder()
                .setType(REGISTER)
                .setPayload(chaincodeId.toByteString())
                .build();
    }

    static ChaincodeMessage newEventMessage(
            final Type type, final String channelId, final String txId, final ByteString payload) {
        return newEventMessage(type, channelId, txId, payload, null);
    }

    static ChaincodeMessage newEventMessage(
            final Type type,
            final String channelId,
            final String txId,
            final ByteString payload,
            final ChaincodeEvent event) {
        final ChaincodeMessage.Builder builder = ChaincodeMessage.newBuilder()
                .setType(type)
                .setChannelId(channelId)
                .setTxid(txId)
                .setPayload(payload);
        if (event != null) {
            builder.setChaincodeEvent(event);
        }
        return builder.build();
    }

    private static Response toProtoResponse(final Chaincode.Response response) {
        final Builder builder = Response.newBuilder();
        builder.setStatus(response.getStatus().getCode());
        if (response.getMessage() != null) {
            builder.setMessage(response.getMessage());
        }
        if (response.getPayload() != null) {
            builder.setPayload(ByteString.copyFrom(response.getPayload()));
        }
        return builder.build();
    }

    private static String printStackTrace(final Throwable throwable) {
        if (throwable == null) {
            return null;
        }
        final StringWriter buffer = new StringWriter();
        throwable.printStackTrace(new PrintWriter(buffer));
        return buffer.toString();
    }
}